我试图在Sphinx Python文档系统中编写一些等式。我一直在努力使以下多线方程起作用： .. math:: P_{Survival} (L) = P_{S} (L) = exp \{ - \frac{ \sigma (E) \rho L}{m_{T}} \} P_{Interaction} (L) = P_{I} (L) = = 1 - P_{S} (L) = 1 - exp \{ - \frac{\sigma \rho L}{m_{T}} \} 它们显示为一个连续的内
我的文档中有一些图像是在Sphinx中作为一组reST文件创建的。我更喜欢将它们保持在非常小的位置，我希望用户点击它们以获得更大的图像。较小的图像不是因为文件大小的原因，而是因为显示的原因。我没有找到一种语法方法将标签image:或figure:与ref:或链接：组合在一起 .. image:: _static/my_image_small.png 我在同一个文件夹中有一个更大的版本：my\u image\u large.png 如果您提出了一个解决方案，那么较大的映像应该是一个带有显式链接的
如何在sphinx中自定义headerlink .. page.html page ==== My header ______ My headerresolve to linkhttp://example.com/page.html#my-标题 如何获取http://example.com/page.html#my-自定义标题链接？您可以引用以下格式的链接： page ==== `My Header <http://example.com/page.html#my-custom-h
当尝试构建文档（任何类型：html、手册页、latexpdf…）时，sphinx在尝试自动记录项目的子目录时失败。我尝试了许多不同的方法来缩小问题的范围，但我似乎找不到罪魁祸首。所有rst文件都是由sphinx apidoc生成的 目录A具有以下rst文件： Directory A ======================================= Submodules ---------- .. toctree:: A.fileB A.fileC A.fil
我完全不知道如何链接到reST文件中的另一个文档 我想在段落中将名为install.rst的文件链接到我的快速入门指南。我不知道如何才能做到这一点 请您也参考一个很好的资源，我可以从中查找rest的语法。默认的快速入门有点枯燥，并且不涉及将rest与sphinx一起使用的深入讨论 所讨论的文档是：要引用其他文件，我必须在conf.py中包含以下内容。我从枕头（PIL fork）的文档中获取了代码 我想国际狮身人面像的扩建对我有帮助。它跨其他文档页面链接。要在不同的StructuredText（.
StructuredText是否提供了一种编写多段警告的方法，特别是todo 我试过。。todo：：一行，后面是两个缩进的段落。它不起作用；第一段出现了，第二段没有。同样的结果，当我连续写了两个。。todo:：指令。我无法重现该问题。请告诉我们您使用的确切标记。
如何在StructuredText中的指定链接中格式化文本 具体而言，我希望从rst生成以下HTML： <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> 然而，这给了我们一个机会 <tt class="docutils literal">`optpar
我想将定义为希腊字母的变量添加到sphinx文档中的词汇表中。例如： .. glossary:: :math:`{\alpha}` Definition for alpha 目标是让这些变量出现在文档的索引中。有这方面经验的人？术语表术语会自动添加到索引中。但这对问题中的术语表条目不起作用。Sphinx发出以下警告：警告：无效的单个索引项“”（至少对我来说是这样）。这感觉像个虫子 以下是两种解决方法： 使用替代品 |alpha| Description of a
我想知道是否可以在Sphinx和/或RST中使用动态路径。包括：：指令 我这样做的原因是，我有一些由Sphinx在一个repo中生成的开发人员文档，但我们在另一个repo中有一系列单元测试，我们希望将它们包含在文档中。如果我知道另一个repo中文件的路径，这是非常标准的，如下所示： Some text in my RST file .. include:: ../path/to/other/repo/file.py :code: python Some more text 问题在于，到其他
使用automodule时，是否有指令或方法从函数中修剪导入路径的一部分 例如，当使用automodule指令时，我有如下内容： .. automodule:: super.cool.thing.my_module :members: :undoc-members: 这很好地生成了包含模块中函数的文档，但显示了完整路径。如果我将add_module_names设置为False，它将完全删除所有路径信息，只保留函数名。如果在多个模块中有相似的命名函数，这可能会有点混乱。因此，我希
如何在phyton sphinx生成的文档中显示HTML字符代码 sign : @ 我希望在构建rst后显示上述内容，如下所示： sign : @ 但它不起作用，我试过了 编辑 我正在编写一个工具，它将从代码文件中读取一些预定义的标记（例如，@package），然后生成rst文件。然后我使用sphinx构建生成文档。 由于@package已经是我工具中的一个标记，我不想将@package用作文本。e、 g @todo Add tests cases for the @p
我在readthedocs网站上有很多文档，我希望能够将其作为两个单独的PDF文件。我已将每个文件的内容分为两个顶级*.rst文件（formal.rst和unformal.rst），并在conf.py中指定了这两个文件（如建议的），但在构建过程中我遇到了一个错误： Latexmk: Need to specify at most one filename if jobname specified, but 2 were found (after defaults and wildcar
我的Sphinx树中有许多.rst文件，它们被故意从任何索引树中排除。我收到类似这样的警告 /filename.rst:: WARNING: document isn't included in any toctree 如何抑制Sphinx中的特定警告 Sphinx项目中是否存在输出中不需要其内容的.rst文件 使用exclude_patterns配置变量。不会为与指定模式匹配的文件生成输出（也不会生成警告消息）。看 Sphinx项目中是否有不属于任何目录树的.rst文件，但其内容应在输出
我需要使用Sphinx记录我的Python项目。但是我不能使用autodoc 当我配置我的项目时，我选择了选项“extension autodoc”，但是现在如果我使用 .. autoclass:: Class 我得到一个错误： ERROR: Unknown directive type "autoclass" 我配置了PYTHONPATH，现在一切正常。但是我已经有这个问题了 我的索引文件是： .. ATOM documentation master file, created by
Sphinx配置如何在标题中设置“面包屑”？我有一个狮身人面像项目，我看到的只是项目名称；如果我跳入子页面，我会迷路，看不到当前页面的路径 野外的一些例子： 请参阅顶行：文档>>Python标准库>>15。通用操作系统服务 请参见顶部的圆形矩形 scipy的源代码如下所示： 斯芬克斯的“基本”主题似乎内置了“relbar”功能： 发件人： 然后我有介绍 Introduction ============ content goes here .. toctree::
我尝试过以下代码： from docutils.core import publish_string text = publish_string(open(file_path, 'r').read(), writer_name='html') 但它说： <p>Unknown directive type "toctree".</p> 如何从Python代码而不是控制台调用它？以下是我想要做的： import sphinx args
我在.rst文件中有以下文本： Some text. * Heading | The first topic. | Another topic which is very verbose and spans multiple lines ad infinitum. Topic continued...................................... .. |br| raw:: html <br /> 我希望它呈现为： Some text.
我正在使用Sphinx构建代码文档 让我们假设在某个时刻有一个类foobar.Foo的文档，例如 .. autoclass:: foobar.Foo :members: 在另一个地方，我有一个代码示例（包括使用literalclude），其中包含以下行 foo = foobar.Foo() 有没有办法让代码示例中的foobar.Foo自动链接到该类的文档，就像使用 :class:`foobar.Foo` 在普通文本中？否。literalinclude不解析代码。@StevePierc
考虑上复杂性列表中的项目2-3。如何在重构的文本/斯芬克斯中实现同样的效果 我最接近的是写作 | 1) ... | 2-3) ... | 4) ... 但这会破坏列表格式枚举数，并且分割行没有正确缩进。另一个选择是使用表，但我不想要表格式 找到了以下解决方法。将您的列表定义为 .. rst-class:: custom-enumeration ==== === \1) ... 2-3) ... \4) ... ==== === 并将以下代码段添加到CSS文件中 /* Define en
我想通过一些特性扩展内置的sphinx文档扩展sphinx.ext.graphviz。由于这些特性对于我的用例非常特殊，我不想扩展sphinx.ext.graphviz本身 本质上我只是想（） 使用graphviz解析以获取graphviz节点（~graphviz.run（）） 修改节点的graphviz点代码（~node['code']=dotcode） 使用graphviz输出/呈现（html/pdf），无需修改（例如 html:html\u visit\u graphviz（）->ren
我使用Sphinx来记录一个python包，该包封装了一个专有API，据我所知，该API没有使用Sphinx进行记录。API文档提供了有用的信息，但URL的格式不是sphinx可以自动生成链接的格式。在手动指定链接目标时，是否可以在语义上将字符串标记为类 我试过： :class:`Class <https://api.documentation/some/path/to_class_constructor.htm>`_ 它不会发出警告，但也不会生成超链接 根据Steve Pierc
Sphinx在构建文档时生成名为genindex的索引，因此。现在，我如何在目录中包含指向该索引的链接 我试过这个： .. toctree:: :maxdepth: 2 genindex api Indices and tables ================== * :ref:`genindex` 虽然最后一行确实在文档中创建了指向该索引的链接，但构建在创建TOC时不知道引用： WARNING: toctree contains reference to no
我正在尝试。。自动类：：具有实例属性的类： .. autoclass:: synergine.core.Test.Test :members: :undoc-members: :private-members: of（在文件synergine/core/Test.py中）： 但是当我makehtmlsphinx时，会出现以下错误： /home/bux/Projets/synergine/doc/source/Components.rst:143: WARNING: autod
Sphinx有一个“显示源”链接来查看RST源： （示例来自） 我想让“show source”保持活动状态，但我希望将注释放在RST中，而不让它们显示在“show source”结果中 有什么方法可以做到这一点吗？我能提供的唯一线索是，将源代码复制到输出是在标准HTMLBuilder的handle_page（）方法中完成的。我想你必须截取复制操作并过滤掉评论。以某种方式
我使用Sphinx和StructuredText输入和HTML输出来记录基础设施的不同部分。其想法是，阅读文档的用户可以复制示例并将其传递到自己的文件中。对于Makefile示例，如何做到这一点？Makefiles在某些位置需要制表符，但Sphinx将制表符转换为空格 示例：命令行必须以最终HTML中的选项卡开头。这里用三个空格表示缩进和一个制表符： .. code-block:: Makefile target: dependency command -i $< -o $
运行chpldoc并推送到github时，主题被破坏。我是否需要设置标志以允许github插入主题 ==更新== 一个具体的例子是，我使用chpldoc src/*.chpl-o docs运行此操作它看起来像是一个空的.nojekyll文件，需要此链接： 您能否详细说明主题已损坏？在推送到github时，您是否抓取了所有生成的文件，还是仅抓取了与源文件共享名称的文件？在我看来，其他生成的文件似乎丢失了。你是说git add docs/*？是的，我希望该命令足够了。尽管我这么做了，让我再试一次。
我的问题-如何找到丢失的文件/目录 Python3 http服务器在本地为Sphinx html文件提供服务，但是突然它停止了服务-我在终端中发现了这个错误-不确定丢失了哪个文件/目录 /pycon-sphinx-tutorial/crawler/docs/_build/html$ python3 -m http.server 8989 Serving HTTP on 0.0.0.0 port 8989 ... ---------------------------------------- E
我希望从标题编号中继续获得列表编号。我在中尝试了：number:指令。。目录树：，但它只为标题生成数字 例如： Section ===== Sub Section ----------- #. item 1 #. item 2 #. item 3 这将产生： 1。章节 1.1小节 1.1.1第1项 1.1.2第2项 1.1.2.1第3项 产生这种结果的方法（如果有的话）是什么？我认为这是不可能的：(
要在Sphinx中使用reStructuredText引用节，我可以执行以下操作： .. _my-reference-label: Section to cross-reference -------------------------- This is the text of the section. It refers to the section itself, see :ref:`my-reference-label`. 如前所述 这导致章节被标题引用，也就是说我得到了一行： 它
我希望整个TOC中的每个文档都包含在globaltoc侧边栏中。我如何做到这一点 在主题文件中，有对{{toctree（）}的调用，但我不知道toctree（）指的是什么。您可以使用sphinx扩展名在侧栏中包含完整的TOC
项目结构如下： index.rst MyProject ========= Contents: .. toctree:: group1 Group1 ------ Subgroup1 ========= Subgroup1 contents Subgroup2 ========= Subgroup2 contents group1.rst MyProject ========= Contents: .. toctree:: group1 Group1 -
如何在节点中使用rst？例如，我想输出iclude文件about.rst class Foo（指令）： def运行（自）： 返回[ nodes.Text（“**adad**”），#添加内容格式为rst语法的文本节点没有帮助。您需要创建rst节点对象以构建所需的rst元素树。此外，由于您试图在示例中包含另一个rst文件，您需要使用嵌套解析，因为实际内容事先未知，无法硬编码 在rst指令类的run（）方法中，可以调用self.state.nested_parse（）方法。其原始目的是像这样解析指令的
我正在尝试在localhost上安装，一切都很好，只是它运行了很多Sphinx构建器，我不需要它们。具体地说，它运行的是python/path/to/sphinx build-b latex，最终还是会出错，因为我没有安装texlive 如何使RTD只运行回购的html生成器
我已经使用Sphinx和ReadtheDocs主题创建了文档，但是按钮中缺少箭头 有人能帮忙吗 您的Sphinx文档可能使用CSS指定字体，其中这些unicode“代码点框”是箭头 CSS是外部的，但不是与HTML一起提供的，字体也是外部的。请确保sphinx主题的CSS文件位于正确的位置。谢谢。解决了的。我的.gitignore文件中有_静态目录。这包含css
我正在使用Sphinx RTD构建文档 我想有一个链接的地方，并被设计成一个逐字或预先格式化的文本 例如，假设我有以下逐字记录： ALTER TABLE 有没有办法把它链接到某个地方，比如：ref:…，或者仅仅是一个标准的超链接？如果我没有弄错的话，它可以帮上忙 由于StructuredText不支持嵌套的内联标记，因此使用样式化文本创建引用的唯一方法是使用替换“replace”指令： I recommend you try |Python|_. .. |Python| replace:: P
使用sphinx build创建文档目录（html）时遇到问题 我试过了 sphinx-build -b html source build 以及 make html 但在这两种情况下，只生成html文件search.html、index.html和genindex.html。缺少文件modindex.html 在conf.py文件中，我设置了 html_domain_indices = True 所以我应该有一个modindex.html文件。我做错了什么？构建html文件后，我没有收到
是否可以在StructuredText（Sphinx）中创建类似的自动枚举列表 是否有任何指令或其他方式 它应该类似于节编号（） 提前感谢，Denis解决方案就在这里“此案例无法转移到普通有序列表”这是否意味着没有解决方案？ 1. Point 1 1.1. Point 1.1. 1.2. Point 1.2. 2. Point 2.
我想用index.rst文件描述一个别名。然后我想使用，这个别名，其他rst文件。可能吗 例如 在index.rst文件中： .. |n1| image:: /_static/Number1.png :width: 64px 然后我想在page1.rst、page2.rst文件中使用这个别名 |n1| some texts. 您可以使用rst_epilog；看见
我想记录的项目结构如下： /top Index.rst /a toctree_a.rst (contains doc and doc2) doc.rst doc2.rst /b toctree_b.rst (contains doc4 and doc3) doc3.rst doc4.rst 我想引用子目录（a和b）中的目录树s，以便项目目录树可以看到项目树中的4个文档 当文档位于一个目录中时，我知道如何执行此操作，
我的项目有以下sphinx目录结构 /applications /app1 Content.rst /app2 Content.rst /components /component1 Content.rst /figures Figure1.png /component2 Content.rst /figures Figure1.png 对于每个可重用的UI软件组件，我都有一个单独的目录，其中包括
我能否将sphinx的差异index1.rst作为build。/build/html\u 1/的参数，以及index2.rst作为build。/build/html\u 2/的参数： 我在sphinx build文档中找到了如何定义目标文件夹，但没有关于指定index.rst文件的内容您可以根据环境变量设置master\u doc 在conf.py中： import os master_doc = os.environ.get('INDEX') 在Makefile中，您可以传递所需的环境变量：
我的手写文档/用户指南（使用sphinx以StructuredText编写）变得相当大，因此我开始在子目录中组织我的.rst文件 在index.rst中，我包含了每个子目录的subindex.rst，它本身包括其他.rst-文件，用于进一步的子目录 index.rst： .. include:: subdir1/subindex.rst .. include:: subdir2/subindex.rst .. include:: file1.rst .. include:: file2.rst
我从命令行运行sphinx build命令来构建latex和html文档，因为它们具有相同的源.rst文件： $sphinx build-bhtml $sphinx build-b latex 但是，对于latex输出，我希望忽略所有“include”指令 可以通过在与sphinx的conf.py相同的目录中添加docutils.conf文件来实现，该文件包含以下内容： [parsers] [restructuredtext parser] file-insertion-enabled:fals
因此，我的问题是，我正在为我们的一个产品生成一个文档，该项目分为两页，并添加了一个额外的项目符号（如下圈所示）。我如何删除这个错误的项目符号，或者干脆强制列表项进入下一页 分割线语法 * I am a very long statement and I create a bullet when I continue on to the next line. Why does this happen? I am using rst2pdf to generate this document. Pl
我有两个重复的钥匙->。。命令：：targetName在我的文档中的两个单独页面上。我需要知道如何使用以下语法链接到这两个单独的目标： Page-1 Click this -> :command:`targetName` # this will always open the first targetName declared in the doc 目标： Page-1单击此->：命令：`targetName`#不工作：/ 第2页单击此->：命令：`targetName`#不工作：/
我正在尝试将我们的API文档及其专有文档生成器模式迁移到StructuredText。最困难的是，我们有一个API详细信息的表格表示，直接用HTML编码，一个la: --------+------------+--------+--------------------------------+ Param | Required | Type | Description ---------------------------------------------------------
我正在尝试使用sphinx创建po文件 sphinx intl更新-p build/locale/-l de 然而，它产生的输出看起来像 #: ../../source/my-documentation.rst:16 msgid "" "Far quitting dwelling graceful the likewise received building. " "Unaffected remarkably get yet introduced excellence terminated le
我正在尝试用rst编写文档，并使用Sphinx构建网页。我遇到的问题是，带有@符号的代码被Sphinx转换为mailto链接 This is the command prompt: pi@raspberrypi ~ $ 如何停止此操作？尝试以下操作： This is the command prompt: .. code-block:: bash pi@raspberrypi ~ $
pygments将代码块转换为非常丑陋、语义无效的标记 比如这个rst .. code block:: html <html> <head>... head of the document ...</head> </html> <pre> <code> <html> <head>... head of the document ...</head
我的项目有两个积极维护的版本（2.x和3.x）。3.x较新，但我仍在发布2.x文档的更新 如何在ReadTheDocs上拥有我的文档的两个分支？我想象的是： https://foo.readthedocs.io/en/2.x https://foo.readthedocs.io/en/3.x 当前，如果有人转到https://foo.readthedocs.io/en/latest，他们得到了2.x文档，但一年后我想把它翻过来指向3.x文档 在阅读页面时，我似乎想要2个“发布分支”，但我找不到