问题标签 [python-sphinx]

我正在使用 Sphinx 的“手动”文档类，除了页眉之外，我对 Latex 输出的外观非常满意。它包含我论文的标题，以及“Release 1”。

由于我正在写论文而不是文档，因此我显然不需要发布信息。不幸的是，很难找到有关如何自定义 Sphinx 乳胶输出的信息。

有人知道怎么做吗？

我正在使用带有 autodoc 的 Sphinx 来记录我的 Django 项目。

设计人员希望有关于项目中定义的所有模板标签的文档页面。当然，我可以通过手动枚举所有模板处理函数来制作这样的页面，但我认为它不是 DRY，不是吗？其实模板标签处理函数都是用@register.inclusion_tag装饰器标记的。因此，某些例程将它们全部收集并放入文档中似乎是可能且自然的。

过滤功能也是如此。

我已经用谷歌搜索了它，搜索了 Django 文档，但都在脉络中。我简直不敢相信这样一个自然的功能还没有被任何人实现过。

我正在使用Sphinx创建我的项目的文档。我想使用扩展sphinx.ext.pngmath和这个小测试：

我得到了错误：

我已经安装了包 texlive-latex-base。

谢谢你，魔方

我有具有对象属性的 Python 类，这些对象属性仅在运行构造函数时声明，如下所示：

如果我现在使用help(Foo)或尝试Foo在 Sphinx 中记录，则不会显示self.basepathandself.availableruns属性。这对我们 API 的用户来说是个问题。

我尝试寻找一种标准方法来确保解析器可以找到这些“动态声明的”属性（最好是文档字符串），但到目前为止还没有运气。有什么建议么？谢谢。

我想在我的机器上使用 virtualenv 而不是本机环境来构建 html 文档。

我已经进入了 virtualenv，但是当我运行时，make html我收到错误消息，提示无法导入模块 - 我知道这些错误是由于该模块在我的本地环境中不可用。在搜索文档时如何指定应该使用哪个环境（例如 virtualenv）？

我正在使用 Sphinx 来记录 Web 服务。我想使用代码块指令显示格式化的 JSON Web 响应，这是 Spinx 通过 Pygments 执行的，但 JSON 在 Pygments 中没有语法高亮显示。你建议我指定什么语言？HTML？JavaScript？

我正在使用 Sphinx 来管理我的项目文档。

我有一个无序列表，我希望每个项目的第一行都是一个代码段。（不是内联，一个段落。）

我怎样才能做到这一点？

我使用 Sphinx 来记录 Python 库。到目前为止效果很好，我得到了很好的 HTML 和 LaTeX 输出。关于 Latex，Sphinx 生成一个完整的独立文档，其中包含许多特殊的包和配置。

但是，我想将生成的 Latex 文件集成到已经存在的 Latex 项目中（更准确地说：在书的附录中）。特别是我希望 Sphinx 生成的文档页面具有父文档的页眉、页脚和节标题样式。我想我可以通过手动删除不需要的东西并调整Sphinx 生成的tex文件中的各种选项来以某种方式转移相关部分。然而，这可能会是一个非常乏味的摆弄，占用我太多时间（考虑我必须检测和修复的冲突包和选项）。

Sphinx 的 Latex-Builder 是否支持这样的用例？如果没有，是否有更通用的方法来合并独立的 Latex 文档？

感谢您的任何提示！

如何在 Sphinx 文档中创建内部超链接？我在用：

但它不起作用。

是否可以在 Sphinx 文档生成器中添加文本删除线？