问题标签 [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.
python - 添加自定义链接到 hudson 项目页面
我正在使用 Hudson 为使用 Sphinx 的 Python 项目生成文档。这会在文件夹 project/_build/html 中生成 HTML 文档，我将其设置为用作构建工件。现在运行作业后，我可以通过单击“Artifacts”链接导航到文档，然后单击文件夹，然后单击 index.html 文件。这有点麻烦，所以我想自定义项目页面，这样我就可以有一个“查看文档”链接，直接将我带到 index.html 文件。哈德森有什么办法吗？
python - 将 Sphinx 与 distutils 构建的 C 扩展一起使用
我编写了一个 Python 模块，包括一个用 C 编写的子模块：模块本身被调用foo，C 部分是foo._bar. 结构如下：
foo/__init__.py导入_bar以增强它，并且有用的东西暴露在foo模块中。这在构建时工作正常，但显然不会以未编译的形式工作，因为_bar在构建之前不存在。
我想使用 Sphinx 来记录项目，并在模块上使用autodoc扩展。foo这意味着我需要先构建项目，然后才能构建文档。
由于我使用 distutils 构建，构建的模块最终会出现在一些可变命名的 dir 中build/lib.linux-ARCH-PYVERSION——这意味着我不能将目录硬编码到 Sphinx'conf.py中。
那么如何配置我的 distutilssetup.py脚本以在构建的模块上运行 Sphinx 构建器？
为了完整起见，这里调用（“假”的东西是子类和setup的自定义构建器）：buildbuild_ext
python - 自动文档参数？
我是使用狮身人面像的新手。它看起来很不错。我几乎已经使用 autodoc 记录了我的所有项目，但我想改变一种行为。阅读文档，我看到了这个：autodoc_member_order，并且想要更改为 'bysource' 值，关键是，我应该把这个值放在哪里？
谢谢，我为我糟糕的英语道歉。
更新：我正在使用狮身人面像 0.6.6
python-sphinx - 格式化 reStructuredText 中链接中的文本
如何在 reStructuredText 中指定链接中格式化文本？
具体来说，我希望从我的第一个 HTML 中生成以下 HTML：
结果应如下所示：
其中“optparse.OptionParser”部分是固定宽度的字体。
我试过
然而，这给了
看起来像这样
``optparse.OptionParser
documentation <http://docs.python.org/library/optparse.html>\_
latex - 狮身人面像定制 Latexpdf 输出？
只是好奇是否有人知道在使用 latexpdf 目标时如何自定义 sphinx 输出？我已经看到了很多用于 html 输出的自定义内容，但似乎找不到任何自定义 pdf 输出的示例。
具体来说，我有兴趣自定义标题页、页眉、页脚，并可能在内容之前添加几页前页。
有没有人见过这种定制的任何例子，或者人们在生成 pdf 时几乎只是使用“股票”狮身人面像输出？谢谢！
java - 如何在 Jython 项目中创建基于 Sphinx 的文档？
我正在使用用 Java 编写的库处理几个 Jython 项目。感谢 autodoc 扩展，我想用 Sphinx 创建一些好的文档。但是，当我尝试创建 html 时，出现错误，因为 autodoc 找不到用 Java 编写的库：
其中 PoolManager 是一个 Java 类。
谁能帮我解决这个问题？
django - Django 中的 Sphinx 文档
我目前正在我的 Django 应用程序中集成 sphinx 生成的文档。我想要文档来扩展我的应用程序模板。Sphinx 生成的 HTML 应该是这样的
我的狮身人面像主题模板看起来是：
有没有更好的方法来实现这一点？
python - sphinx、buildbot（和代码覆盖率）。他们如何整合？
我有一个不那么小的 python 包，有相当多的历史，用文档字符串记录。在其开发过程中，我们引入了buildbot，后来又引入了Jenkins/Hudson。最近，我在我的 .js 中添加了一个sphinx配方buildbot.cfg，以便从源代码中收集文档并保持最新的 Web 可访问文档。
到目前为止，一切都很好：每次我提交更改时，Jenkins 都会仔细检查包，生成非常完整的概述并更新我们的文档站点。
我启用的 sphinx 扩展之一：coverage，用于文档覆盖率报告，目前未记录。
我在我的 buildbot 生成的环境中执行 sphinx，我似乎没有设法在 sphinx 生成的文档站点中包含覆盖率统计信息！
任何提示？
django - 狮身人面像自动文档帮助
尝试使用 sphinx 的 autdoc 扩展，但它不起作用。我将“docs”文件夹保存在 djano 项目文件夹中。它没有为我的模块生成文档。我也不确定自动待办事项是如何工作的。
python - 如何从 python 生成 reST/sphinx 源？
我想通过 reST 生成文档，但不想手动编写 reST 源代码，而是让 python 脚本来做，然后用 sphinx 生成其他格式（HTML、PDF）。
想象一下，我有一本二进制格式的电话簿。现在我使用 python 脚本来解析它并生成一个包含所有名称和数字的文档：
然后我会继续调用 sphinx 来生成 pdf 和 html：
是否有提供 API 用于生成 reST 的 python 模块（在上面的示例中也称为 restProducer）？还是通过几个打印语句转储 reST 标记的最佳方法？