使用 Sphinx 创建 HTML 格式的上下文相关帮助文件
我目前正在使用 AsciiDoc 来记录我的软件项目，因为它支持 PDF 和 HTML 帮助生成。我目前正在通过 Cygwin 运行它，以便 a2x 工具链 正常运行。这对我…
让 Sphinx 从 pydoc 生成 RST 类文档
我目前正在将所有现有（不完整）文档迁移到 Sphinx。 问题是文档使用 Python docstrings （该模块是用 C 编写的，但它可能确实没关系）并且类文档必须…
狮身人面像和英语以外的语言
我发现在 http://svn.python.org/projects/doctools/trunk/sphinx/语言环境 支持在 Sphinx 中使用的多种语言，但我没有找到如何安装它的说明：应该下…
在 App Engine 上安装 Sphinx - 可能吗？
继我的去年关于文档的问题之后，我现在想开始尝试基于 Python 的 Sphinx 用于整理我一直在开发的 PHP CMS 的开发人员文档。 我不想在我的工作站上本地…
Sphinx/Pygments 中有没有一种方法可以强调文字包含中的一行或多行代码？
在我正在编写的一些 sphinx 文档中，我包含了来自辅助文件的代码示例，如下所示： .. literalinclude:: mymodule.py :pyobject: MyClass :linenos: 这…
在 Sphinx 中，我可以注册一堆应该始终翻译成链接的关键字吗？
我的文档字符串引用了我定义的其他 python 类。每次 Sphinx 遇到这些类之一时，我希望它插入另一个类的文档链接。这在狮身人面像中可能吗？ 具体来说…
Sphinx、reStructuredText 显示/隐藏代码片段
我一直在使用 Sphinx 和 reStructuredText。 在我的文档中，有一些很长的代码片段。我希望能够将它们默认隐藏，并使用一个小“显示/隐藏”按钮来展开…
docutils 和 Sphinx 之间有什么关系？
Python 似乎有很多文档工具。我遇到的另一个是 epydoc。看起来 Sphinx 是事实上的标准，因为它用于生成官方 Python 文档。有人可以帮我整理一下 Pytho…
使用 RestructedText 和 Sphinx 包含预格式化文件
我正在尝试使这个片段起作用： Version History --------------- These are the versions over time:: .. include:: ../../CHANGES.txt 也就是说，使…
如何覆盖Sphinx插入的英文标签
我使用 Sphinx Python 文档生成器。创建 PDF 文档非常容易和简单，但我有一个问题。 所有生成的 PDF 文档都包含“chapter”、“release”和“part”等…
Sphinx 文档中的条件输出
我正在使用 Sphinx 编写一些文档，并且我只想打印特定的文本块适用于 HTML 文档，不适用于 LaTeX 文档。有些东西告诉我我应该能够使用 sphinx.ext.ifc…
在 Sphinx 中，有没有办法在声明参数的同时记录参数？
我更喜欢在声明参数的同一行记录每个参数（根据需要），以便应用 DRY 如果我有这样的代码： def foo( flab_nickers, # a series of under garments to…
从 Javadoc 迁移到 Python 文档
所以我已经有点习惯了 Javadoc 风格的文档。浏览 Python 代码的各种示例，我发现乍一看，文档似乎缺少很多信息。 好处是：你很少会看到不言而喻的文档…
