我试图限制Sphinx HTML Biulder生成的边栏toc的深度。我试图用我自己的更改localsidebar.html，但在中找不到任何提示，只有不推荐的选项{{toc}}包含呈现的本地toc，但在呈现之前没有关于如何使用它的信息。尝试将以下行放在文件顶部： :tocdepth: <n> ：toc深度： 是您想要的深度。我在_templates/layout.html中的主题定制中设置maxdepth，看到了最好的边栏结果。rst目录树文件层次结构中不需要额外的指令选项

假设您有一个重构的文本文档，并希望使用Sphinx2.x将其导出为两种格式：HTML和PDF 您希望在这两种格式中放置一些稍微不同的内容。例如，文本“我是HTML”显示在HTML版本中，而“我是PDF”显示在PDF版本中文档的同一位置 无论导出格式如何，使用下面这样的替换指令都会给出“I am HTML” .. |foo| replace:: HTML ⋮ I am |foo| 您能为不同的导出格式使用不同的指令吗？这有点笨重，但它对我有用： .. role:: latex(raw)

我想定义和样式标题，如图所示-浅色部分包含章节名称，文档标题位于深色部分 现在我只能让文本向右对齐的浅灰色部分 如何定义标题样式来实现这一点？另外，如何将这些方块插入布局中 谢谢 我想定义和样式标题，如图所示-浅色部分包含章节名称，文档标题位于深色部分。 不幸的是，这个功能还没有很好的文档化。以下是实现此目的所需的步骤： 如果尚未在conf.py中设置自定义模板配置，请执行此操作 rinoh_documents=[dict（doc='index'，target='manual'，template

我正在用Sphinx生成html文档 如何修改文档中每个html页面的侧边栏，使其包含目录树？默认情况下，目录树似乎只显示在master\u doc页面中，并且只显示在主区域而不是侧栏中 有没有一个简单的方法可以做到这一点？我将使用readthedocs托管生成的文档，因此我宁愿避免使用任何第三方插件，除非它们也可以在readthedocs上使用。您可以在conf.py中自定义html侧栏 默认html侧栏由4个模板组成： ['localtoc.html', 'relations.html',

我想了解如何在单词之间插入图像，例如： Lorem ipsum :imageshouldcomehere: dolor sit amet. 在斯芬克斯有可能吗？如果是，如何回答？我想应该回答你的问题 Lorem ipsum |image_reference| dolor sit amet. .. |image_reference| image:: <path/to/img> Lorem ipsum | image | u reference | dolor sit amet。

我正在将斯芬克斯与重构文本一起使用。我可以使用反引号来创建内联文本，比如 This is an ``object`` =>这是一个对象 但是，如果内联文字后面紧跟着一个字母，则后引号中的文字不会呈现为内联文字 They are ``object``s. =>它们是“对象” 如何获得以下所需的渲染 =>它们是对象s.在您的情况下，您需要转义s，例如 They are ``object``\s. 结果将是 它们是objects 你可以试试这个

我有一个RST文件，我不想要任何语法突出显示。它包含多个文字块和文件顶部的highlight指令，用于尝试禁用语法高亮显示： .. highlight:: none :: Text that happens to contain words like list, None, etc. :: Another literal block with words like list, None, etc. 项目中的其他一些RST文件使用语法高亮显示和以下指令： .. highlight

我将一些代码和数据示例复制到\u static目录，并希望链接到文档中的这些文件，例如： .. _pca-run.py: _static/example.data 但问题是sphinx没有创建到该文件的适当的相对链接，只是按原样复制值。因此，对于\u static不在同一目录中的嵌套文件，链接不起作用。您需要的是：下载：文本角色。（米塔尔在评论中提到） 使用此命令将告诉Sphinx将给定文件复制到“_downloads”目录并创建指向该文件的超链接。这最初是用于可下载的文件，比如PDF（在h

我正在使用Sphinx/重组文本生成文档。我可以将文本标记为粗体或固定宽度。如何使用以下两种格式标记文本：-粗体和固定宽度？固定宽度**不起作用吗？似乎是这样。我使用的是1.1.3版，并且\**`fixed width``**\生成了粗体文本，包括后面的勾号。我发现了唯一一个显示该工具不起作用的渲染工具。嵌套的内联标记似乎是不可能的，请参阅我的答案。

我正在Windows10中使用Python3.7.2在Eclipse光子下运行Sphinx1.8.2。我有问题让狮身人面像接受我的章节标题结构。考虑下面的文本来源： *********************** Development Environment *********************** Computer Support ================ The following tools are used to support the computer enviro

我有一个reST格式的表格，其中一些单元格包含长文本块，即多个段落或项目符号列表，它们会定期更新，例如： +-------+-----------------------+ |Cat | Chunk that is updated | | | periodically. | | | | | | Line #2, #3, etc | +-------+------------------

自动功能在我的本地机器上运行得很好，但在服务器上它没有显示任何内容。我查看日志，发现以下内容， 警告：autodoc:导入函数bla失败；引发了以下异常：没有名为“numpy”的模块。 我想在sphinx上安装软件包不是必须的。我只需要sphinx来读取我的文档字符串并生成文档 经过几个小时的调查，我终于能够回答我的问题了。使用autodoc_mock_导入就可以做到这一点

我有一本很大的错误参考手册，正在进行转换，以便使用Sphinx在readthedocs上托管。我希望能够根据节号（而不是标题文本）推荐使用永久书签的用户，因为这是软件错误代码中返回的内容。我有点像： This has a chapter heading automatically numbered to give 1. ============================================================ This has a section heading

在使用Sphinx构建文档时，我将其用作默认角色，Sphinx通过自动链接一些标记的引用并将其他引用格式化为代码，同时避免将文档字符串与标记混淆，从而达到预期效果 不幸的是，以这种方式构建文档时，输出中充斥着对any找不到目标的引用的警告： WARNING: 'any' reference target not found: […] 有没有办法抑制这些警告？ 到目前为止，我能找到的关于这种方式的唯一资源是，这是关于一个完全不同的警告的具体信息。我为此提交了一份申请，该申请被拒绝，但产生了一个解

我在一个大型回购中工作，有大约100个单独的文件夹，每个文件夹有20-30个子文件夹，每个子文件夹都包含自己的.py文件夹。目前，我必须使用sphinx apidoc命令为每个文件创建.rst文件，然后将路径添加到conf.py文件，然后将.rst文件添加到index.rst文件。是否有自动化的方法，这样所有这些都只需要几个命令就可以完成 扩展声明它将记录Python包。反过来，要求它们的文件（模块）包含在一个目录中，并且每个目录都包含一个名为\uuuu init\uuuu.py的文件 正确设置

我在makefile中定义了一个条件标记，因此我可以使用唯一的指令有条件地删除文本块 生成文件条目： 。。。 set BUILDDIR=\u build 斯芬克斯建筑-t内部 我有一行信息，需要为特定的文档构建使其消失。以下是一个例子： 概述： 工作区：“xxx” .. 仅限：：内部 xt团队名称：“phoenix”#用于xt Grok-否则排除此行** “internal”指令起作用，但它清除了单行文本之后的所有内容，我不想在这个构建中清除这些内容。在排除的文本行之后，我没有空格键字符或制

我想从一个模板创建几个文件，这些文件只因变量名不同而不同。例如： （文件1.rst）： （模板rst）： 当然，我有一个名为“/images/1-image.png”的图像。将“| variable |”替换为“1”在标题中效果良好，但在图像文件名中效果不佳，在编译时我得到： WARNING: image file not readable: ./images/|variable|-image.png 如何让reST也在变量名中进行替换？（如果这改变了什么，我将使用斯芬克斯）。这里有两个问题：

在我们的ReadtheDocs项目中，我们有一个用例，需要在同一版本的文档的多个页面上显示一些特定的文档。到目前为止，我们可以通过以下方式之一来实现 复制粘贴内容到每个页面的rst文件 用标签将其写入一个相关文件中，并在其余文件中使用：std:ref:将其重定向到主文件 我希望实现这样的功能：只在一个文件中写入内容，然后在每个文件中显示内容，而不为用户重定向。有可能吗？您可以使用 假设您在dir/text.rst中编写文本 其他文件将包括以下内容： ..include :: /dir/text.

问题 我正试图为一个包含许多子目录的Python项目构建文档。我正在尝试使用sphinxapidoc使流程无缝。然而，尽管我尽了最大的努力，我还是无法处理子目录中的代码。我在YouTube上看了一个很好的简短教程，效果很好。为了模拟我一直遇到的问题，我将其中一个文件放在can\u it\u handle\u文件夹中，如下所示 spamfilter-py │ __init__.py (**) │ readme.md │ sample.py │ spamfilter.py │

我有一个用Python编写的Raspberry Pi项目，它使用RPi.GPIO模块。所有关于代码的工作都是在一个不会安装RPi.GPIO的Windows设备上完成的，每次我尝试运行autodoc时，它都会崩溃，说它无法导入RPi.GPIO D:\cube\docs\ledcube.rst:4: WARNING: autodoc: failed to import module u'ledcube' ; the following exception was raised: Traceback

我已经使用Sphinx为我的Django应用程序创建了一组文档。我使用readthedocs.org创建该文档的公共版本。这很有效，但有一点很奇怪。在readthedocs.org上，我的一些文档生成的版本与本地版本不同。例如，对于我的models.py，我创建了models.rst，如下所示： Models ====== .. automodule:: my_app.models Agents ------ Agent ````` .. autoclass:: Agent :mem

我有一个python项目，其结构如下： - dir_1 - base.py - dir_2 - base.py sys.path.insert(0, os.path.abspath('\dir_1')) sys.path.insert(0, os.path.abspath('\dir_2')) 两个“base.py”文件中的内容不同。但是当我使用sphinx进行文档记录时，最新的“base.py”文件/模块的内容正在被记录 对于这两个文件 conf.py中的路径条目如下所示

我在github上有一个存储库： 里面有一个文件 文档/SIR\u 2dgrid.mp4 其中包含我希望在readthedocs的文档中出现的动画（特别是在本页：） 此外，还有一个文件 文件/模拟调查.rst 对该页进行编码并尝试引用该mp4。我尝试了很多变体（尝试在复制指令时进行复制），但没有成功。我能让mp4出现在所需的readthedocs页面上的唯一方法是链接到github上的mp4（但它的加载有点延迟，而且并不完美） 我似乎无法让Docs通过mp4复制到一个目录中，在那里我可以建立一

尝试在readthedocs.org中生成文档时出错，autodoc无法导入一组函数，错误消息如下： WARNING: autodoc: failed to import function 'open_template' from module 'pypyt'; the following exception was raised: Missing required dependencies ['numpy'] 我正在使用需求文件，因此环境实际上正在安装numpy。我尝试过模仿它，autodo

Sphinx Quickstart不会让我超出我们确认需要英文文档的步骤 我有一个现有的CONDA venv，名为-demo_venv。 我激活它并进行pip安装，目录结构如下所示- (demo_venv) dhankar@dhankar-VPCEB44EN:/media/dhankar/Dhankar_1/a5_test_sphinx$ pip install sphinx dhankar@dhankar-VPCEB44EN:/media/dhankar/Dhankar_1/a5_test_

是否有方法合并。。绘图：：斯芬克斯中带有的指令。。测试代码：：1 当使用doctest类型时，我可以像这样集成它们（只是一般的想法）： 然后在示例输出上方插入一个图形。除了使用>>，还可以执行以下操作： .. testcode:: * import matplotlib.pyplot as plt import numpy as np x = np.array([0,1,2]) .. plot:: plt(x) plt.show() .. t

我使用reST中的autoclass指令创建了文档，它为类生成了如下标题： 然而，我想要的是，它不是说dataframe.dataframe，而是说EzPyZ.dataframe（或者实际上是对默认文本的任何手动覆盖）。这是我使用的代码： .. autoclass:: dataframe.DataFrame 答案如我所料。我是个白痴。正如@mzjn所指出的，我所要做的只是简单地说： .. autoclass: EzPyZ.DataFrame autodocs将以您指定的方式填充路径，只要它

这是意料之中的事 Section Header -------------- This is a section header Refer to section above `Section Header <#section-header>`_ 节头 -------------- 这是一个节标题 参见上文“章节标题”一节`_ 但以下方法不起作用 Refer to section below `Section Header <#section-header&g

我的项目主要文档是Sphinx。我还想集成大量的JavaDocs。基本设置是： sphinx\u源代码/ javadocs\u-builded/ 在构建Sphinx文档之前，我可以将JavaDocs复制到Sphinx\u source下的目录中 如何从Sphinx中引用包含非reST文件的此目录，并在构建过程中将其带到一起？您可能需要使用：download:指令来引用这些文件 请参阅： 请注意，您需要单独引用这些文件，因此可能需要设置某种脚本来为您生成引用

我正在使用Sphinx为我的项目生成文档，并在产品安装过程中构建文档 我希望在文本和/或代码块中动态包含主机名。我在文档中没有看到任何解释，也没有看到任何包含shell命令输出或特定文件中特定行以外的任何内容的工具。这个功能存在吗？这里有两个狮身人面像可以做到这一点： ：执行runblock指令中的Python代码，捕获输出并将其插入文档中 ：使用程序输出指令执行任意命令，并将输出插入文档

例如，当用户输入scopes时，我想显示两个结果，这个词在我的文档中出现了两次，但在searchindex.js中没有任何结果，我也没有得到任何结果 有人能解释一下它是如何工作的吗？ （我获得其他搜索的结果，例如api）

我在MS Word中有大约200个单独的文档，每个文档大约有4-6页长 每个文档都定义了一些术语、一些图像、一些表格和源代码列表 我正在考虑将文档转换为rst，并使用Sphinx文档框架将所有文档集成到一个大型文档中，因为它为交叉链接提供了非常好的支持 因此，我预计有两件艺术品： 多页HTML（由生成HTML构建） 单个PDF文档（由make latexpdf构建） 我的问题是：这样多的页面是否可行？ 我预计在以下情况下会出现问题（有些是关键的，有些不是）： 生成结果文档（失败或运行时间较

我正在为Sphinx/rst写一些文档。如何链接到本地磁盘上与您正在查看的页面相关的内容 例如： ==================== My App documentation ==================== The official My App documentation can be found here: https://myapp.com/docs A local mirror is available: ../../_static/docs_mirror/index

我在谷歌上搜索了很多遍后都找不到答案 我第一次尝试sphinx，但我看不到如何在sphinx文档中包含指向其他页面的链接。似乎：doc指令应该可以做到这一点，但它不起作用 例如，假设我有一棵非常简单的树： ./index.rst ./files/CPPFiles.rst ./files/PythonFiles.rst 第一个是，index.rst，并且有一个TOC，它希望在“自由”文本中链接到这些子文件之一，因此my index.rst包含以下内容： My Docs ======= This

我安装了sphinxcontrib plantuml扩展，如果我运行HTML builder（例如，针对相应的testmodule.py文件使用以下testmodule.rst文件），该扩展可以正常工作： testmodule module ================= .. automodule:: testmodule :members: :undoc-members: :show-inheritance: .. uml:: Alice -&g

我正在部署本地实例应用程序readthedocs。当我开始生成文档时，会出现错误 此处记录： 29/May/2015 08:47:00] INFO [requests.packages.urllib3.connectionpool:180] Starting new HTTP connection (1): localhost [29/May/2015 08:47:00] INFO [projects.tasks:87] (Build) [diclonius-doc:] Building [29

也许只是我，但我常常很难理解和驾驭 基于Sphinx的文档，因为目录仅显示 当前页面的结构（至少在标准主题中） 还有一个上一个和下一个，但我真正想看到的是 侧栏中的TOC，显示所有零件，当前零件已展开 例如，主页（即index.rst）将是“概述”，由 违约简介和快速启动是index.rst的两个部分： Overview Introduction Quickstart Credits Tutorial Contribute Index API Search “教程”将作

我正在尝试学习如何管理与其他内容位于同一文件中的目录树元素 假设我有一个类似于以下内容的thingamajig.rst章节： Thingamajigs ============ .. toctree:: :maxdepth: 2 foo bar baz Overview ++++++++ Thingamajigs are fun 当我渲染它时--foo/bar/baz有自己的.rst文件-- Thingamajigs ============ .. toctr

我正在使用生成我的一些项目的文档。我编写了一个简单的构建脚本，可以克隆所有git repo，找到docs目录并执行： sphinx-build -b html -D html_theme=treffynnon -D html_theme_path=/home/user/_themes /home/user/sphinx/src /home/user/output/docs 不幸的是，虽然html\u主题设置正确，但是html\u主题路径没有设置正确。这当然会导致斯芬克斯在找不到主题时抛出错误

如何将reST/Sphinx页面中的交叉引用插入到同一文档集中另一页面的子标题或锚定？表达式“reST/Sphinx”使问题的范围不清楚。它是关于StructuredText和Sphinx，还是只关于Sphinx中使用的StructuredText（而不是StructuredText）？我将介绍这两种情况，因为使用RST的人可能会在某个时候遇到这两种情况： 斯芬克斯 除了可用于链接到类等各种实体的特定于域的指令（：class:）之外，还有通用的：ref:指令。他们举了一个例子： .. _

我正在为一个相当大的项目更新一个常见问题解答，我想在页面顶部添加一个问题索引，这样用户就更容易找到他们想要的 Sphinx文档声明“特殊条目名称self代表包含目录树指令的文档。如果您想从目录树生成“站点地图”，这很有用。”这就是我想要的。问题是self似乎已经崩溃，只包含当前文档的标题，而不包含副标题。当我在另一个文档中并参考FAQ时，它可以正常工作，只有在文档本身中它才会失败 展示 .. toctree:: :maxdepth: 3 faq 在其他文件中，结果为 常见问题

我有一个包含我的项目的工作目录，它位于版本控制系统中。我想在我的项目中创建一个doc目录，其中只包含sphinx的重组文本文件 也就是说，我不想sphinx在我的项目中构建html文件，而是将它们放在外部，这样它们就不会被放在版本控制中。因此，如果您的问题是“如何在源代码树之外构建文档”，帮助： 只需将builddir指向源代码树之外的位置 或者，根据您的版本控制系统，将生成文档的目录添加到“忽略文件”（例如，.gitignore，.hgignore，…）我正在使用sphinx quicksta

我正在使用sphinx，我创建了多个rst文件来组织我的文档。我用了。。include:：将多个rst文件包含到一个配置文件中，但当使用：ref:`时，这会保留文件名标题标签，但当我单击链接时，它会隔离页面，但我希望它滚动到同一页面中的引用。当我使用时将滚动到同一文档中的区域，但不再保留标题标签。有没有一种方法可以在保持文档在不同文件中的同时，保持引用标题标签和在同一页面中滚动 index.rst Welcome to testing's documentation! =============

Sphinx RTD中是否可以突出显示代码块中的特定单词？我知道有强调行，但我不想强调整行，而只强调代码的特定部分。也许您可以使用解析文本。此指令处理内联标记，但不提供语法突出显示。例子：

假设我在reStructuredText中有一个表，比如： +---------------+---------------------------+ | key | value | +===============+===========================+ | short_word | value_1 | +---------------+-------------------

在Python的Sphinx中，如何记录由于\uu getattr\uuu而可用的属性 我有一个配置管理器的实例，它允许通过与节名匹配的属性访问配置的任何节，即配置管理器。 现在，我在.rst文件中（但更喜欢在代码中）记录了以下内容： .. autoclass:: ConfigManager :members: :var .<section_name>: Access any section of the configuration by its name. ..

我有一个sphinx术语表术语，类似于这样，它用一个替换来使用下标进行适当的格式化 |VOH| Minimum output voltage representative of a logic 1 .. |VOH| replace:: V\ :sub:`OH`\ 我怎样才能正确地引用文档中其他地方的术语以及正确的下标格式？下面这个看似显而易见的尝试，对于backticks中的replace不起作用 :term:`|VOH|` 你的问题与另一个问题很接近，但答案是肯定的。单靠reST是

我正在使用sphinx处理一些经过重组的文本文档，并希望将定义为字段的值从一个文档替换为另一个文档 给定一个文件foo.rst，我想在另一个文档中使用其Author字段的值。例如，它的定义如下： Foo === :Author: Random, Joe; Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliq

以下rST指令不支持尾随空格： :code:`foo ` 例如： >>> from docutils import core >>> whole = core.publish_parts(""":code:`x `""")['whole'] <string>:1: (WARNING/2) Inline interpreted text or phrase reference

我有一个Sphinx项目，有几页，每一页都有几个部分。例如，在my_page.rst中，我会按此方式标记各节： .. _sec_foo: Foo ~~~ 我可以从Sphinx文档中链接到这些部分，例如 :any:`sec_foo` 我希望能够从web上的其他地方提供一个指向我的“Foo”部分的链接，而不必知道它在my_page.rst中 我想象这样的东西重定向到上面的链接，但是任何让我移动的解决方案_sec_foo:从一个页面切换到另一个页面，而不更改我在其他地方的链接，这是可以接受的 有