python-sphinx 相关问题

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

标准 C 类型的 Sphinx 警告“未找到参考目标”

在 nitpick 模式下运行的 Sphinx 会发出警告，例如“警告：c：未找到类型引用目标：wchar_t”和“警告：c：未找到标识符引用目标：wchar_t”对于

python-sphinx restructuredtext

回答 1 投票 0

Sphinx autodoc（如果 Python 方法移至 Rust PyO3）

如果我有一个Python模块和一个方法： # mymod.py def 函数(x): ”“” 返回一个值。 ”“” 返回x 第一个文件中的 Sphinx autodocument 命令： API...

python rust documentation python-sphinx pyo3

回答 1 投票 0

如何导入嵌套的 jinja 宏？

我想将嵌套的 jinja 宏导入到其余文件中并调用它。所以我们有 main.rst 文件，它导入一个 collection_of_macros.jinja 并且在 collection_of_jinja_macros.jinja 里面是一个...

jinja2 python-sphinx restructuredtext

回答 1 投票 0

sphinx，重组文本：颜色单元格/表格行

有没有办法为sphinx表格中的特定行着色？我尝试使用 .. role:: ，它与 sphinx、restructedtext: set color for a single word 中讨论的 CSS 文件相关。然而...

html python-sphinx restructuredtext

回答 2 投票 0

将 CSS 类添加到 Sphinx 表格单元格

有没有办法将 CSS 类添加到 Sphinx 生成的 HTML 表中？例如，我想修改以下RST表定义： +--------+ |细胞1 | +--------+ |细胞2 | +--------+ 生成...

python-sphinx restructuredtext

回答 1 投票 0

Python 文档字符串中段落后的项目符号列表有时不适用于 sphinx 和 numpydoc

使用 numpy 样式记录 Python 模块并使用 sphinx 和 numpydoc 扩展生成 html 文档，我偶然发现了一个有关项目符号列表的错误（或功能？）。在

python-sphinx restructuredtext numpydoc

回答 1 投票 0

如何强制Sphinx中的自定义js/css文件始终加载更改而不缓存？

在conf.py中我有： html_css_files = ['css/custom.css'] html_js_files = ['js/custom.js'] 但是，如果我在 custom.js 或 custom.css 中进行任何更改，那么此更改不会反映在用户的 b...

javascript css caching python-sphinx browser-cache

回答 1 投票 0

避免sphinx中的换行

生成sphinx文档时如何将两个单词保留在同一行？例如，我希望 2 秒内的 2 和 sec 之间没有换行符。例如，我想避免以下布局：是...

python-sphinx

回答 1 投票 0

在 Sphinx 中的文件链接中使用版本号

在Sphinx中，可以使用以下语法生成文件链接： `name_of_file.js `_ 在conf.py文件中，定义了一个版本变量，我们可以在...

versioning python-sphinx

回答 2 投票 0

Sphinx 中的任意换行符

Sphinx 允许使用 |br| 在 HTML 输出中任意放置换行符符号。然而，这不适用于 Latex 或 EPUB。 Sphinx 有什么方法可以在...中指定任意换行符吗？

python-sphinx restructuredtext

回答 1 投票 0

交互式会话中出现空行问题

在我使用 reStructuredText 编写的一份技术文档的其中一个部分中，我想包含一个交互式会话和此输出。例子： >>> 帮助（模块）阿斯达斯德

python-sphinx restructuredtext

回答 1 投票 0

Sphinx：强制在文档中的节之前添加小节

我想编写一个文档页面，其中包含以下内容：标题 ***** 介绍性文字包含更多详细信息的小节 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 细节第1节 ========= 第2节 ...

python-sphinx markup restructuredtext

回答 1 投票 0

Sphinx 中的图像没有 html 链接

如何简单地防止使用 :scale: 属性的 Sphinx/reStructuredText 中图像的自动链接？文档导出为 HTML，我希望图像不要被点击...

image hyperlink python-sphinx restructuredtext

回答 1 投票 0

我可以替换 ReStructuredText 中的图形指令吗？

我有一个 .rst 文档，它是使用 wp2rst （使用 pandoc）从 Wordpress 导入的。在导入过程中，我的所有图像都被翻译成替换的.. image:: 如下：这是一些文字|

wordpress python-sphinx pandoc substitution restructuredtext

回答 1 投票 0

是否可以使用 sphinx 使用 :class: 角色链接到特定 URL？

我正在使用 Sphinx 来记录一个 python 包，该包包装了一个专有 API，据我所知，该 API 并未使用 Sphinx 进行记录。 API 文档提供了有用的信息，但是 URL...

python-sphinx restructuredtext

回答 1 投票 0

如何在 reStructuredText 指令选项中指定空格或空字符串？

我想要一个空字符串或一个空格作为标题 - 我该怎么做？ .. 代码块:: c ：名字：永远：标题： ”” 为了（;;） { ; } 这不起作用，我得到一个混乱的错误...

python-sphinx restructuredtext

回答 1 投票 0

如何使用README.md文件作为shpinx readthedocs的主页

我有一个 README.md 文件，其中包含该包的一般概述，并且想使用 spinx 将该文件作为主主页添加到我的文档中，您能告诉我如何将其添加到我的

python-sphinx read-the-docs toctree

回答 1 投票 0

使用 Cerberus 模式自动化文档编制

我们广泛使用 cerberus 来验证 json 配置文件。因此，我们有各种各样的模式，它们定义了这些 json 文档的格式。我们希望能够...

python python-sphinx cerberus

回答 1 投票 0

即使管道成功，Gitlab 页面也无法部署

我正在尝试使用 sphinx 生成的 html 部署 GitLab Pages 静态站点。我的 .gitlab-ci.yml 文件如下：图片：高山：最新页面：标签： - 狮身人面像阶段：部署脚本： ...

gitlab gitlab-ci python-sphinx gitlab-pages

回答 1 投票 0

自动生成所有Python包内容的文档

我正在尝试使用 Sphinx 为我的代码库自动生成基本文档。但是，我很难指示 Sphinx 递归扫描我的文件。我有一个带有文件夹的 Python 代码库

python python-sphinx documentation-generation sphinx-apidoc

回答 5 投票 0

python-sphinx 相关问题

最新问题