Sphinx是一种工具，可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档，但它是一个通用工具，可用于记录任何内容。
使用Python3.11 Sphinx 7.2.6生成的HTMLHELP文件无法使用hhc.exe编译
我们的软件使用Sphinx来生成文档、网站、chm等... 我们正在尝试从 python2.7 切换到 python3.11 阻塞点之一如下： 我们运行 sphinx -b htmlhelp...
我有以下文档字符串： def 测试（foo）： “”“这是我的功能 .. 代码块:: python 炫酷功能 现在我应该在代码块之外。 乙...
Napoleon 过度转义参数名称中的尾随下划线，导致未知目标名称错误
我现在正好遇到了本期中描述的问题：https://github.com/sphinx-doc/sphinx/issues/7734。该期还提供了 MWE。 我的问题只是看不到修复...
sphinx-autodoc 忽略 conf.py 中的默认设置
我们有一个Python项目，这样做是为了生成文档： sphinx-apidoc --module-first -f -o 源/ ../src 制作html 在最近的 sphinx (6.1.3) 中，我们注意到一个问题。其中一个班级有一个 cl...
Python sphinx 自动摘要错误：“未知指令类型“自动摘要””
我有一个 sphinx 文档，当我包含以下几行时： .. 当前模块:: myMod ..自动摘要:: 我的课 我收到以下错误 错误：未知的指令类型“自动摘要”。 然而，
我使用 Sphinx 生成 HTML 和 PDF 文档。到目前为止，默认的 PDF 输出还可以，但我的经理给我发了一个 Word .dotx 模板，并说 PDF 应该是相同的“企业”风格......
我的index.rst中有一个目录树，看起来像这样： .. 目录树:: ：最大深度：2 猫 狗 驼鹿 我希望嵌套我的 toctree 的内容，类似于它的完成方式......
Sphinx 警告：无法从模块 `pythontemplate` 导入 test.test_adder
上下文 创建 root_dir/docs/source/conf.py 并自动为 root_dir/src （和 root_dir/test/）目录（及其子目录）中的每个 .py 文件生成 .rst 文件后，我
我想在 sphinx 网站中居中对齐并加粗标题，在 markdown 文件中定义为： # 我的标题 我试过把 .center h1 { 文本对齐：居中； } 在 _static/css/c...
我正在编写文档，我想包含 pdf 文件或 zip 档案的链接。我如何使用 rst 语言和 sphinx 来实现这一目标？ 如果我这样做 这是一个 pdf 文件：`pdf 我正在编写文档，我想包含 pdf 文件或 zip 档案的链接。我如何使用第一种语言和 sphinx 来实现这一目标？ 如果我这样做 here is a pdf file : `pdf <doc/mypdf.pdf>`_ 它不起作用，因为在编译期间 sphinx 不复制 doc 目录的内容（我使用 sphinx-quickstart 生成的 makefile）。 相反，使用 image 指令： .. image:: img/plop.png sphinx 会复制构建目录中的 plop.png 图像。如何获得 pdf 或 zip 存档的相同行为？ 解决方案是使用 :download:“角色”（有关角色的 sphinx 文档中有详细介绍）。 这是一个简短的示例，假设您在目录 mypdf.pdf 中有一个文件 doc。目录 doc 和您的第一个文件必须位于同一目录中： here is a pdf file :download:`pdf <doc/mypdf.pdf>` 请注意，:download:和文件路径之间不能放置空格。 image指令仅适用于带有 PDF 文件的 HTML。 .. image:: doc/mypdf.pdf 请勿使用它，因为它具有误导性。感谢 G. Milde 的评论。
我从事一个开源项目，该项目由 python API 以及许多扩展模块组成，这些扩展模块作为单独的 python 包安装。所有这些扩展都位于自己的 github 中
有没有办法在sphinx文档中自动显示变量var1和var2及其初始化值？ 我的班级： ”“” 班级说明 ”“” def __init__(self, p...
阅读 GitHub 上的构建推送未构建的文档 - 无错误消息
我有一个“构建文档”自动构建，它是由 Git 中心的 Webhook 触发的。它以前可以工作，但今天突然不再工作了，而且我没有收到任何明显的错误消息（但是...
在 nitpick 模式下运行的 Sphinx 会发出警告，例如“警告：c：未找到类型引用目标：wchar_t”和“警告：c：未找到标识符引用目标：wchar_t”对于
Sphinx autodoc（如果 Python 方法移至 Rust PyO3）
如果我有一个Python模块和一个方法： # mymod.py def 函数(x): ”“” 返回一个值。 ”“” 返回x 第一个文件中的 Sphinx autodocument 命令： API...
我想将嵌套的 jinja 宏导入到其余文件中并调用它。 所以我们有 main.rst 文件，它导入一个 collection_of_macros.jinja 并且在 collection_of_jinja_macros.jinja 里面是一个...
有没有办法为sphinx表格中的特定行着色？ 我尝试使用 .. role:: ，它与 sphinx、restructedtext: set color for a single word 中讨论的 CSS 文件相关。然而...
有没有办法将 CSS 类添加到 Sphinx 生成的 HTML 表中？例如，我想修改以下RST表定义： +--------+ |细胞1 | +--------+ |细胞2 | +--------+ 生成...
Python 文档字符串中段落后的项目符号列表有时不适用于 sphinx 和 numpydoc
使用 numpy 样式记录 Python 模块并使用 sphinx 和 numpydoc 扩展生成 html 文档，我偶然发现了一个有关项目符号列表的错误（或功能？）。 在
如何强制Sphinx中的自定义js/css文件始终加载更改而不缓存？
在conf.py中我有： html_css_files = ['css/custom.css'] html_js_files = ['js/custom.js'] 但是，如果我在 custom.js 或 custom.css 中进行任何更改，那么此更改不会反映在用户的 b...