问题标签 [python-sphinx]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
internationalization - 狮身人面像和英语以外的其他语言
我发现在
http://svn.python.org/projects/doctools/trunk/sphinx/locale
支持可以在 Sphinx 中使用的几种语言，但我没有找到有关如何安装它的说明：应该下载哪些文件并将其安装在哪些目录中？
任何提示将不胜感激。
python - 让 Sphinx 从 pydoc 生成 RST 类文档
我目前正在将所有现有（不完整）文档迁移到Sphinx。
问题是文档使用Python 文档字符串（模块是用 C 编写的，但可能无关紧要）并且类文档必须转换为可用于 Sphinx 的形式。
有sphinx.ext.autodoc，但它会自动将当前文档字符串放入文档中。我想根据当前的文档字符串在 ( RST ) 中生成一个源文件，然后我可以手动对其进行编辑和改进。
您如何将文档字符串转换为 Sphinx 的 RST？
restructuredtext - 在 Sphinx 和 reStructuredText 中引用带有数字的数字
在编写将使用Sphinx处理的 RST 时，我无法让 Sphinx LaTeX 输出在引用数字时使用数字数字。例如，这段代码：
会转换成这样：
旅鼠正在攻击，正如他们来了！
/图片在这里/
图 1.1：他们来了！
但我想要的是引用数字的“标准”LaTeX 方式，如下所示：
旅鼠正在攻击，如图 1.1 所示
我如何实现这一目标？我目前使用的代码是 Sphinx 手册推荐的，但它不会产生我想要的输出。
python - 使用 Sphinx 在 HTML 中创建上下文相关的帮助文件
我目前使用AsciiDoc来记录我的软件项目，因为它支持 PDF 和 HTML 帮助生成。我目前正在通过 Cygwin 运行它，以便a2x 工具链正常运行。这对我来说效果很好，但在其他 Windows 计算机上设置很痛苦。我一直在寻找替代方法，最近重新访问了 Sphinx。注意到它现在会生成 HTML 帮助文件，我试了一下，它似乎在我执行的小测试中运行良好。
我的问题是，有没有办法在文本中为上下文相关帮助指定地图 ID，以便我的 Windows 程序可以调用正确的帮助 API 并启动文件并将其打开到所需位置？
在我使用的 AsciiDoc 中pass::[<?dbhh topicname="_about" topicid="801"?>]。通过使用这些结构 acontext.h和alias.h与其他 HTML 帮助文件（上下文相关帮助信息）一起生成。
python - Sphinx autodoc 不够自动化
我正在尝试使用 Sphinx 在 Python 中记录一个超过 5,000 行的项目。它有大约 7 个基本模块。据我所知，为了使用 autodoc，我需要为项目中的每个文件编写如下代码：
这太乏味了，因为我有很多文件。如果我可以指定我想要记录“mods”包会容易得多。然后，Sphinx 可以递归地遍历包并为每个子模块创建一个页面。
有这样的功能吗？如果不是，我可以编写一个脚本来制作所有 .rst 文件，但这会占用大量时间。
c++ - C++ 中的狮身人面像 (Linux)
这次我想在Linux中实现Sphinx。请给我执行相同操作所需的API，否则相关链接也可以。虽然我发现很多 PHP 的，但 C++ 没有。
我还在我的应用程序中使用了 GTKmm。
python - 是否有 ReST 文件的智能编辑器？
我正在学习 Sphinx，我需要编辑 ReST 文件。有智能编辑器吗？比如，一个给我代码着色、简单缩进、代码完成（希望如此）等的编辑器。
python - 狮身人面像自动模块不愿意导入翻译
我偷偷怀疑斯芬克斯不喜欢我的翻译课。当我尝试执行自动方法时：
我收到这个警告：
路径之类的都是正确的。我试过直接在 conf.py 中导入翻译，也有类似的问题。当我尝试类似的东西时，我仍然遇到问题：
from translations.models import Translation as t
它能够导入，但 Translation 中的导入最终导致 Sphinx 返回相同的错误。
有问题的文档在这里：
python - Python 的网站如何生成其在线文档？
使用 Sphinx 0.6.5 创建。
我知道 Python 的文档使用reStructuredText，但它有不同的部分，例如http://docs.python.org/whatsnew/2.6.html和http://docs.python.org/tutorial/index.html。
你如何在 reStructuredText 中做到这一点？您是否rst2html在一堆目录中运行并保持其结构？
我知道它使用 Sphinx（不是Thomas Wouters 在回答中直接说的 rst2html ），但是您应该如何在存储库中使用源代码文件组织您的第一个结构，以便拥有一个完整的自动化文档网站？
python - Python doctests / sphinx：风格指南，如何使用这些并拥有可读的代码？
我喜欢 doctests，它是我唯一使用的测试框架，因为它写起来非常快，而且因为与 sphinx 一起使用，它几乎不费吹灰之力就能制作出如此出色的文档......
然而，很多时候，我最终会做这样的事情：
我的意思是我把我所有的测试和文档解释都放在了模块的顶部，所以你必须愚蠢地滚动才能找到实际的代码，这很丑陋（在我看来）。但是，我认为文档测试应该仍然保留在模块中，因为您应该能够在阅读源代码时阅读它们。所以我的问题来了：sphinx/doctests 爱好者，你如何组织你的 doctests，比如代码可读性不受影响？是否有针对 sphinx 的 doctests 样式指南？对于带有 sphinx 的文档字符串，您使用google 或 sphinx style-guide还是其他方式？