如何使 Python/Sphinx 文档对象属性仅在 __init__ 中声明?
我有带有对象属性的 Python 类,这些属性仅在运行构造函数时声明,如下所示: class Foo(object): def __init__(self, base): self.basepath = base t…
当我尝试简单的表达式时 sphinx.ext.pngmath 引发错误
我正在使用 Sphinx 创建项目的文档。我想使用扩展 sphinx.ext.pngmath 并通过这个小测试: Returns the indefinite integral of the polynomial *poly…
如何摆脱“Release 1”在 Sphinx Latex 输出的页眉中?
我正在使用 Sphinx 的“手动”文档类,并且我对 Latex 输出的外观非常满意,除了页面标题之外。它包含我论文的标题以及“Release 1”。 由于我正在写…
在 Sphinx 中,我如何创建可链接的“术语”?没有大量开销的部分?
我想创建一个“术语”部分,其中包含我正在使用的术语的定义,这样每次我使用此术语部分中的术语时,都会创建一个指向该定义的链接。 目前,我能想到…
Python Sphinx autodoc 和装饰成员
我正在尝试使用 Sphinx 来记录我的 Python 类。我使用 autodoc 来执行此操作: .. autoclass:: Bus :members: 虽然它正确地获取了我的方法的文档字符…
“意外的章节标题” Sphinx——numpy 是问题吗?
在我的 doc/ 目录中运行时 sphinx-build . html/ ,我得到以下输出: $ sphinx-build . html/ Running Sphinx v0.6.4 No builder selected, using def…
在 (Python) Sphinx 文档中*按原样*包含文本文件
(使用 Python-Sphinx 文档工具) 我有一个 .txt 日志文件,我想将其构建到 _build/html 未更改中。我需要在 conf.py、index.rst 等中更改什么。 这是…
Python doctests / sphinx:风格指南,如何使用它们并拥有可读的代码?
我喜欢 doctests,它是我使用的唯一测试框架,因为它编写起来非常快,而且因为与 sphinx 一起使用,它几乎不费吹灰之力就能制作出如此出色的文档.....…
Python的网站如何生成其在线文档?
使用 Sphinx 0.6.5 创建。 我知道Python的文档使用reStructuredText,但它有不同的部分,例如http://docs.python.org/whatsnew/2.6.html和http:// do…
Sphinx automodule 不愿意导入翻译
我偷偷怀疑 Sphinx 不喜欢我的翻译课。当我尝试执行自动方法时: .. automethod:: translations.models.Translation.new 我收到此警告: /Users/dash/…
C++ 的狮身人面像(Linux)
这次我想在Linux中实现Sphinx。请给我执行相同操作所需的API,或者相关链接也可以。虽然我找到了很多 PHP 的,但没有找到 C++ 的。 我还在我的应用程…
在 Sphinx 和 reStructuredText 中用数字引用数字
当编写将使用 Sphinx 处理的 RST 时,我无法让 Sphinx LaTeX 输出使用图引用数字时的数字。例如,这段代码: The lemmings are attacking, as can be …
使用 Sphinx autodoc 自动递归记录所有模块
我正在尝试使用 Sphinx 来记录 Python 中的 5,000 多行项目。它有大约 7 个基本模块。据我所知,为了使用 autodoc,我需要为项目中的每个文件编写这样…