Sphinx-autodoc with napoleon（Google 文档字符串样式）：有关块引用和缩进的警告和错误
我正在使用 Sphinx 4.4.0 和 napoleon 扩展（Google 文档字符串）。我有这两个问题 ARNING：块引用结束时没有空行；意外的未缩进。 错误：意外的缩进…
使用 Django 标签生成 sphinx 文档
我正在尝试使用 Django 项目的阅读文档模板生成 sphinx 文档。 我使用 Django 标签记录它 例如 Download :model:`ManagementSoftware.Order` CSV 当我…
Sphinx：类描述中的文字块导致与属性/方法表重叠
您好，我对 Sphinx 有疑问，我的描述文本似乎与属性和方法表重叠。当我向类描述添加缩进（文字块）时会发生这种情况。如果我的类描述没有任何缩进，则…
函数在 Sphinx autodoc 生成的文档中出现两次
背景信息 我通过 Sphinx autodoc 从文档字符串生成文档。源文件 mypackage/mypackage.py 中有一个函数 mypackage.mypackage.foo()。它在 __init__.py …
将函数文档嵌入到 sphinx 的页面中
我有一个中型 python 项目，目前正在使用 sphinx 和 autodoc 扩展来记录该项目。我已经掌握了基础知识，生成的文档看起来很合理。 我现在遇到了一个有…
Sphinx 忽略文件名中以 _ 开头的 py 文件
我正在 测试项目中使用 Sphinx 4.4.0。我使用 sphinx.ext.autodoc 和 sphinx-apidoc。 但并非所有 py 文件都能被识别。看起来文件名中以 _ 开头的文件…
如何将目录（TOC）从index.rst链接到README.rst？
我的 docs/ 文件夹中有一些 sphinx 文档。在那里我有一些手写的和从代码（Python）动态生成的文档的典型结构。我希望为打开存储库的人提供一个非常简…
ReadTheDocs Sphinx PDF 文件中的标题和章节混乱
由于某种原因，字幕成为 ReadTheDocs 为我的文档生成的 PDF 中的章节。 在这里查看：https://yarsaw.namantech.me/_/ downloads/en/latest/pdf/ 这是…
Python sphinx 文档 - 使用 autodocsumm 扩展的自动摘要链接不一致
我正在使用 Sphinx autodocsumm 扩展和以下自动摘要配置为 Python 项目生成文档，以在文档开头仅显示类的摘要。 Module1 module --------------------…
sphinx gettext 翻译工作流程的替代方案？
除了 gettext 之外还有其他服务可以构建翻译文档吗？我在想也许有一个选项可以从直接放置在源目录中的 *-fr.rst 或 *-es.rst 文件进行构建。这也适用…
在Sphinx中分割源文档（即管理文件层次结构）
在 Sphinx 中分割源文档的正确方法（如果有）是什么？ 我有一个很大的文件，我们称之为file1.rst，它的结构是这样的： Section 1 ********* Subsectio…
Ruby 相当于 Sphinx 文档生成器？
Ruby 有一些很好的文档生成器，例如 Yard、rDoc，甚至 Glyph。问题是 Sphinx 提供网站、PDF、epub、LaTex...等。它在重组文本中完成所有这些事情。 在…
为具有特定标题的通用狮身人面像警告定义标记
我正在使用 Sphinx 为 Python 程序生成 HTML 文档。 我想使用通用警告 指令具有特定的标题，并以我可以定义的方式对其进行标记，例如使用 note 指令生…
在不使用 pdflatex 的情况下从 Python 创建一个 Latex pdf 表
我想生成一个由 python 脚本内的 Latex 创建的 pdf 输出。 由于我在 Windows 下使用 python xy 工作并且无法安装 Latex，所以我想知道是否有一种…
