如何在不使用 RST 表格式的情况下在 reStructuredText 中生成表格输出？
我正在尝试将我们的 API 文档及其专有文档生成器架构迁移到 reStructuredText。最困难的部分是，我们有一个 API 详细信息的表格表示，直接用 HTML 编…
如何使用Sphinx管理多个版本的文档？
Closed. This question is opinion-based. It is not currently accepting answers. 想要改进这个问题？更新问题，以便可以通过编辑这篇文章用事实和…
在 Sphinx 文档中包含文档字符串
我想在我的 Sphinx 文档中仅包含特定函数的文档字符串。但是，似乎没有选项可以使用 http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.…
如何在一个分支中构建文档并自动将 build/html 复制到 gh-pages 分支
Github 将项目网站存储在项目存储库的单独分支（gh-pages）中。 我们在 master 中有一个 sphinx 包来构建我们的文档，并希望自动将生成的文档提交到 g…
本地运行 Tornado 文档
本周我正在使用 Facebook 的 Tornado 框架，有时我会进入互联网不稳定的地区。由于 网站 位于存储库中，如何让它在本地运行？是在AppEngine下吗？ 我…
如何在 (pdflatex) sphinx 文档中的目录前添加前言或前言？
我如何使用 Sphinx 生成一个 pdflatex 文档，其中有一些目录之前的文本？生成的 LaTeX 文件似乎总是在任何文档正文文本之前有 \tableofcontents 。 我…
Sphinx/DocUtils 创建自定义文档
我正在尝试使用 Sphinx 为我的每个方法创建一些 HTML div。 问题是，我想完全自定义 Sphinx 生成的代码。 我相信这样做需要创建一个自定义指令并告诉 …
sphinx.ext.autodoc：将常量名称保留在签名中
我正在使用 Sphinx 的 autodoc 功能来记录我的 API。 示例： DEFAULT_OPTION = 'default' def do_something(msg, option=DEFAULT_OPTION): print msg …
如何使用Python以编程方式生成Sphinx文档的一部分？
我正在使用 Sphinx 为我的项目生成文档。 在此项目中，我在 yaml 文件中描述了可用命令的列表，该文件一旦加载，就会生成以下形式的字典{command-name…
使用带有哨兵对象的默认参数的 Sphinx python 方法进行记录？
如果您希望能够允许人们使用 None 调用某些方法，您必须使用 sentinel 对象。 _sentinel = object() def foo(param1=_sentinel): ... 这将允许您调用 …
如何超链接 Sphinx 中 Python 模块的方法？
在使用 Sphinx 编写文档时，我知道我可以使用 Intersphinx： :py:class:`logging.Logger` 但是如何直接链接到特定方法，例如 logging.Logger.warning(…
Python - Sphinx 添加图像出现错误
在chapter1.rst中，我有以下内容： TEST **** * Test1 .. image:: ../images/snap.png 当我运行sphinx-build（Sphinx 1.0.7）时，我收到此错误： 发生…
Sphinx、literalinclude、linenos：如何在文档代码片段上显示源代码文件中的实际行号？
我正在使用 Sphinx 来记录网页上的部分 Javascript 代码。 我使用 .. literalinclude:: ../examples/mapviz-step1-simple.html :language: javascript…
使用 Sphinx 文档，如何为 HTML 构建指定 png 图像格式，为 Latex/PDF 构建指定 pdf 图像格式？
使用 sphinx 文档生成器，我尝试使用 .png 图像来构建文档的 HTML，然后我希望将 .svg 图像用于 PDF/LATEX 构建。 有人知道如何将部分“标记”为“仅 …
