python-sphinx 相关问题

Sphinx是一种工具,可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档,但它是一个通用工具,可用于记录任何内容。

如何在Python Sphinx autodoc中删除没有空格的子字符串?

我需要删除 Sphinx autodoc .rst 文件中不带空格的子字符串,以与 strike

回答 1 投票 0

警告:文档未包含在包含文件的任何目录树中

我收到警告: 警告:文档不包含在任何目录树中 对于文档中存在的文件,因为它们已被明确包含。所以我有索引文件: .. 目录树:: :

回答 5 投票 0

使用 Supabase 将访问控制的静态文档集成到 SolidJS 应用程序中

我正在尝试创建一个以 Supabase 作为后端、SolidJS 作为前端的网站。该网站的用户已登录,使用 Supabase 进行身份验证,并且可以访问一些文档,基于...

回答 1 投票 0

Sphinx conf.py 找不到我的外部类

我的文件夹结构如下所示: 根/ —文档/ -来源/ -_utils/ -utils.py -conf.py 在 conf.py 中,我想从 utils.py 文件导入一个类。 我这样做 来自_utils....

回答 1 投票 0

在 Python 中以编程方式将 reStructuredText 转换为纯文本

假设我在字符串中有一些 reStructuredText 源 来源=“” =========== 介绍 =========== 你好世界。 .. 代码块:: bash $ 回声问候。 ”“” 导入系统 导入文档。

回答 3 投票 0

如何在 Sphinx 自定义指令中添加引用?

我正在创建一个自定义指令来显示 pydata-sphinx 主题中所有可用组件的列表。我尽量避免使用原始指令,因此我正在构建一个自定义指令以保持兼容......

回答 1 投票 0

在sphinx jinja2模板中,获取当前文档的路径

我正在使用 Sphinx 和 rST 构建文档。这些文档已国际化并部署到如下路径: website.tld/en/index.html 网站.tld/de/index.html 现在我想在每一页上...

回答 2 投票 0

当页面上不存在该短语时,“搜索...”需要永远阅读文档

当我搜索 readthedocs 页面上不存在的短语时,我收到消息: “寻找……”,这将永远持续下去。相反,当我搜索一些已知的短语时,...

回答 2 投票 0

Sphinx 添加代码格式:ref:

我想向参考添加代码格式,如下所示: :参考:`__插槽__ ` 我的 intersphinx_mapping 定义 python 如下: intersphinx_mapping = { 'python': ('https://

回答 1 投票 0

我可以使用sphinx.ext.viewcode显示行号吗?

我正在使用 sphinx.ext.viewcode 来记录我的 API。是否可以在生成的代码块上显示行号,如果可以,如何显示? 我尝试在文档中找到 html_option 但没有找到

回答 1 投票 0

如何将Meta (Facebook) Pixel添加到Sphinx生成的网页中?

我已经从Meta获得了Meta Pixel,并且我有一个用Python文档工具制作的网站,名为Sphinx。 现在我需要在我的页面的头部添加Meta Pixel的生成代码,ri...

回答 1 投票 0

Sphinx with Matlab 不会生成文档

我有重要的 MATLAB 库,我想通过 Sphinx 记录它们。数据结构大致如下 |- MATLAB |- 脚本 |- 函数 |- 文档 |- 来源 ...

回答 1 投票 0

Sphinx +breathe HTML 输出与 doxygen HTML 输出不同

我需要你的帮助。 我使用 Sphinx 创建了一个文档。 在本文档中,我需要添加另一个有关 C API 的文档。该 API 有现成的 doxygen 文档...

回答 1 投票 0

创建将其他指令包装在其中的指令

我们正在尝试创建一个将其他指令包装在其中的指令。下面的例子将展示一个例子: 指令 ========= ..service_card_wrapper:: .. 服务卡:: ..

回答 1 投票 0

缩短Sphinx中Python类型注释的显示格式

鉴于名为 mymodule 的模块中的以下函数,我想使用 Sphinx 和 autodoc 对其进行记录: 从输入 import Union 从 collections.abc 导入 Iterable 从 numpy.typing 导入

回答 2 投票 0

在没有 pdflatex 的情况下从 Python 创建一个 Latex pdf 表

我想生成一个由 python 脚本内的 Latex 创建的 pdf 输出。 由于我在 Windows 下使用 python xy 工作并且无法安装 Latex,我想知道是否有办法

回答 2 投票 0

在Python Sphinx图像指令中使用环境变量

我有一个带有 Sphinx 文档的 Python 项目,为了保持代码存储库较小,我想要包含在文档中的一些图像和其他文件位于单独的存储库中。 对于 Sphinx 文档

回答 2 投票 0

无法使用sphinx和poem导入模块本身

我想要什么 https://github.com/ShortArrow/pyxlimg 我想在上述项目中发布以下文档。 https://pyxlimg.readthedocs.io/en/latest/ https://readthedocs.org/projects/py...

回答 1 投票 0

Sphinx 在 django 的自定义包中使用 django `get_user_model` 模拟问题

我正在为 django 项目创建一个自定义包。该包包含两个身份验证后端。我的模块配置如下, # 后端1模块 从 django.contrib.auth 导入

回答 1 投票 0

从 Sphinx 生成的 github.io 页面中渲染 Mathjax 的问题

我正在使用 Sphinx 为我的 python 项目编写文档。 这是我的conf.py 数学在本地主机上渲染得很好,但是当部署在 github.io 上时,它似乎不起作用。 在本地主机上 在 github 上...

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.