python-sphinx 相关问题

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

reStructuredText 书目字段正确使用

使用 python 文件的 reStructuredText 书目字段的正确方法是什么?

回答 2 投票 0

Docutils 节点中文本和原始源的区别。文本?

创建新节点如nodes.title时,需要提供两个字符串: 原始来源 文本 我经常看到这样的情况: 节点.title('foobar', 'foobar', ids=[id]) 或者某个时候... 节点.target('', '') 我会...

回答 1 投票 0

Docutils:遍历部分?

如何在Sphinx中遍历文档的每个节名称? (docutils 的文档在哪里?除了 Sphinx 应用程序之外,很难找到任何有用的东西......

回答 2 投票 0

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

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

回答 1 投票 0

如何使用Sphinx在reStructuredText中添加博客样式标签

对于用 reStructuredText 编写并使用 Sphinx 呈现为 HTML 的编程语言文档项目,我想将我的函数分组为逻辑组,例如:字符串(所有字符串函数),...

回答 3 投票 0

如何在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

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