Sphinx是一种工具，可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档，但它是一个通用工具，可用于记录任何内容。
Sphinx autodoc和OpenCV（cv2）错误（Python 3.7）
[首先，说我对狮身人面像完全陌生。我正在使用opencv的图像处理项目。虽然我已经能够设置狮身人面像（并使用一些简单的模块成功对其进行了测试），但我还是...
我如何在同一段中创建两个单独的外部链接，例如：对于pytorch单击`此处 `_，对于tensorflow单击`此处 在this answer之后，使用raw-html角色代替。 添加到conf.py： rst_epilog = """ .. role:: raw-html(raw) :format: html .. |pytorch| replace:: :raw-html:`<a href="https://www.pytorch.org">here</a>` .. |tensorflow| replace:: :raw-html:`<a href="https://www.tensorflow.org">here</a>` """ 在您的.rst中： |pytorch| and |tensorflow| extlinks扩展名旨在缩短外部链接，但它也允许人们指定一个 链接描述文本 要使用它，请在conf.py中执行以下操作 # enable `extlinks` extension extensions = [ 'sphinx.ext.extlinks', ] # add external URLs extlinks = { 'pytorch': ('https://www.pytorch.org/%s', 'pytorch'), 'tensorflow': ('https://www.tensorflow.org/%s', 'tensorflow') } 现在在文档中执行以下操作： Incidentally :tensorflow:`some <>` libraries turn out to be more popular than :pytorch:`some <>` 输出应该看起来像这样 偶然地some库比some 更多>
如何在reST中包含另一个程序生成的内容的index.html链接
我的RST目录如下：。 |-Makefile |-构建| |-文档树| `-html | |-codecov
使用以下代码，我们可以创建每个末尾包含数字的方程。 \ documentclass [12pt] {article} \ usepackage {mathtools} \ begin {document} \ begin {align} 100 + x＆= y ...
Sphinx-quickstart在询问“分离源目录和构建目录”后中止]]
我继承了一个在docs目录下包含sphinx-quickstart生成的工件的项目。一些内容已更改，我想重建它们。我用了sphinx-quickstart ...
抱歉，这很容易，但是经过大量Google搜索后，我找不到答案。我第一次涉足狮身人面像，但我看不到如何在狮身人面像文档中包含指向另一个页面的链接。似乎...
我写了一篇文章，并将其放在我的本地apache2上，您可以看到这是第二篇文章。显示文章中的内容。为什么找不到它？
可以将Sphinx设置为根据标题编号（非文本）自动创建书签吗？
我有一个很大的错误参考手册，该手册正在转换中，以便使用Sphinx托管在readthedocs上。我希望能够根据章节号（不是...
我想使用一些能说明特定含义的信息性图标。将鼠标悬停在图标上，您会看到一个工具提示，显示其含义。允许非图形用户代理（例如执行...
Sphinx构建的主文档的路径可以在conf.py中指定。但是，此目录路径反映在生成的HTML中，例如在“读取文档”中显示为缺少索引。我是...
假设您有一个reStructuredText文档，并希望使用Sphinx 2.x以两种格式导出它：HTML和PDF。您想在这两种格式中放入一些稍有不同的内容。例如，...
我将Sphinx与reStructuredText输入和HTML输出配合使用，以记录基础结构的不同部分。这个想法是，阅读文档的用户可以复制示例并将其粘贴到...
我需要从RST更改Sphinx生成的Latexpdf的封面。如何在不修改Sphinx包本身的情况下做到这一点？我已经在conf文件中注意到了latex_preamble，但那只是...
[使用狮身人面像，是否有可能使出现在代码片段中的单词具有悬浮框，类似于angular.js登陆页面中代码示例中的悬浮框的外观和行为？
我有几个不同的Sphinx项目，我想在本地相互引用（没有Web服务器）。我为项目设置了单独的代码+构建目录，并尝试使用intersphinx ...
Sphinx toctree最大深度，用于显示，但不用于导航侧栏
我想在根索引中使用这样的内容：.. toctree ::：maxdepth：1 sub1 / index sub2 / index因此，仅显示顶级标题。但这也限制了导航...
如何在Sphinx autodoc中的函数签名之间创建水平线和空白
我已经找到了我想执行的大多数操作的狮身人面像选项，但是使用autodoc时，我看不到如何在函数签名之间插入空格和水平线。这是autodoc ...
对于狭窄的窗口，完整的“读取文档”窗口将显示内容，但是当窗口加宽时，目录显示为侧边栏，并且内容小于窗口宽度的一半。怎么可以...