如何使用Sphinx注释掉toctree条目？

文章/答案/技术大牛

发布

2回答

python-sphinx、toctree

我是Sphinx的新手，我似乎没有找到实现这一点的方法。我希望能够在进行过程中快速注释/取消注释单个toctree条目，而不必删除行。我使用Latex来做这件事，以便在我的项目仍在进行中时减少编译时间。例如，我想要实现这样的结果： .. toctree:: file1 .. file3 (I want to comment/uncomment this, easily

浏览 58提问于2021-04-02得票数 0

回答已采纳

1回答

如何在不添加新文档的情况下在Sphinx toctree中添加标题？

python、python-sphinx、restructuredtext、toctree

好的，我正在使用Sphinx Autosummary为一些类生成文档。有三种不同类型的类，我希望我的侧边栏有三个不同的部分，就像我在toctree指令中使用:caption:选项一样。因此，我添加了将autosummary指令分隔为三个较小的指令，并在它们之间放置一个隐藏的toctree，如下所示： Section 1 :hidden: :toctree

浏览 23提问于2019-12-14得票数 1

1回答

如何在sphinx.ext.autosummary中隐藏侧边栏中的目录？

python、python-sphinx、documentation-generation、toctree

我需要Sphinx自动摘要扩展来使用:toctree: generated/生成存根，但我也想防止目录条目出现在HTML侧边栏中。========== ---------- .. toctree最后，我留下了缺少的存根文件，没有存根文件，子子包的类和方法既不存在TOC条目，也不存在模块路径。使用Sphin

浏览 76提问于2021-06-26得票数 0

1回答

外部链接条目上未显示目录树编号

python-sphinx、read-the-docs、toctree

我目前正在用Sphinx写一个技术文档。我使用编号的目录树。当我在toctree中插入外部web链接时，呈现的条目不包含数字。对于此toctree： .. toctree:: :hidden: Administration <admin/admin.rstDownload <https://squash-tf.readthedocs.io/en/lat

浏览 19提问于2019-02-28得票数 1

1回答

在toctree中选择包，但不选择模块

python-sphinx、glob、toctree

我正在使用Sphinx为存储库生成文档。Sphinx toctree允许使用:glob:自动选择某些文档。我有一个表格的toctree :maxdepth: 1 _generated/some/repository/structure/但是，当toctree输出时，这会同时获取包和模块。我尝试过使用_generated&#x

浏览 1提问于2018-02-01得票数 1

1回答

使文档的标题级别自动依赖于它们所属的(sub(sub(sub(.)文件夹的深度级别

python-sphinx、restructuredtext、sections、toctree

假设我有： :maxdepth: 3 subfolder1

浏览 3提问于2020-12-04得票数 2

回答已采纳

3回答

Sphinx将Markdown文件中的标题添加到文档结构

markdown、python-sphinx、toctree、commonmark

我已经将Sphinx配置为使用markdown文件。在我的index.rst文件中 .. toctree:: :caption: Contents: ## H2 Heading 当我渲染主页时，H2标题出现在toctree中。我还有我的toctree的其他部分，我想让:maxdepth大于1。为什么sphinx读取H2标题作为

浏览 27提问于2019-02-21得票数 0

回答已采纳

2回答

如何用sphinx生成函数签名？

python、python-sphinx

py r'''============== :toctree===================================== ------------- :maxdepth: 1ref:`genindex`* :ref:`search` $ cat do

浏览 1提问于2016-01-17得票数 6

2回答

Toctree激活边栏上的当前页和主页

python、python-sphinx、sidebar、read-the-docs、toctree

但是，当我转到另一个页面(在我的例子中是annotation-module.rst )时，侧栏选择并显示index和annotation-module，如下所示：但是，我希望只有注释模块页面被激活并显示它的子部分我的conf.py只通过查找READTHEDOCS环境变量来使用html_theme，如下所示： try: import sphin

浏览 0提问于2018-07-22得票数 1

1回答

使用numpy样式的格式设置被Sphinx忽略。

python、numpy、python-sphinx

_meta :undoc-members:我的Sphinx配置文件(我更改的部分)：extensions = ['sphinx.ext.autodoc','sphinx.ext.napoleon']当我尝试

浏览 0提问于2016-02-16得票数 3

回答已采纳

1回答

折叠所有:glob：-发现的文件为一个TOC条目

python-sphinx、toctree

我有这样的东西： :maxdepth: 2 :hidden: frontendbackend我希望在tools目录中找到的所有文档都能折叠成一个可扩展的侧边栏 TOC条目。我用sphinx_rtd_theme。Section 1============ ============ Subsection 3

浏览 5提问于2020-12-15得票数 1

回答已采纳

1回答

如何添加图文树条目？

python、python-sphinx、restructuredtext、toctree

我正试图开始使用Sphinx来编写Python文档，而在入门过程中，我似乎遗漏了一些非常基本的步骤。.. toctree::请注意，intro.rst位于具有以下内容的同一个目录中====================================== :maxdepth: 2

浏览 4提问于2017-12-08得票数 6

回答已采纳

1回答

如何防止toctree条目自动编号？

python、python-sphinx、read-the-docs、toctree

我正在使用Sphinx构建我的文档，以便与readthedocs.io一起使用。到目前为止，这一直运行得很好。我将自己定位于(在我看来)优秀的文档。因为我欣赏godot文档中的标题，所以我尝试复制这些标题，首先看看他们是如何做到这一点的。(注:文档末尾有相关章节)然而，当我做同样的事情时，sphinx似乎会自动给我的部分编号，这是我不想要的。这是一个代码示例，解释了我的

浏览 4提问于2019-11-16得票数 0

2回答

递归地使用Sphinx自动摘要生成API文档

python、jinja2、python-sphinx、restructuredtext、toctree

我想使用Sphinx的和从docstring递归地生成API文档。我想要每个模块、类、方法、属性和函数的单独页面。但它根本没有检测到我的模板。以下是到目前为止的相关文件：.. sparse documentation master file, created by contain the root `toc

浏览 3提问于2018-01-03得票数 23

回答已采纳

1回答

将子文件夹中的文件添加到sphinx文档中(sphinxcont肋骨-matlabdomain)

matlab、python-sphinx、read-the-docs、toctree

如何使用Sphinx创建一个TOC树，以嵌套的方式包含子文件夹？Folder1 def.m Folder2.1 jkl.m.. toctree::这个moduleslist.rst文件： :maxdepth如何

浏览 2提问于2015-11-02得票数 9

2回答

如何创建一个不会出现在狮身人面像树中的标题？

python、python-sphinx、toctree

我正在使用Sphinx为Python模块创建文档。我想要小的部分和简短的(几行)描述。将每个节标题添加到图库树中将使浏览文档变得更加困难。:alt: ModernGL :figclass: align-center ********** ********** *********

浏览 6提问于2017-06-01得票数 7

回答已采纳

1回答

差异: for深度:用于toctree中的特定条目(Sphinx)

python、python-sphinx、toctree

我为我构建的库提供了一些基于Sphinx的文档，除了changelog之外，我还想显示我所有页面的扩展目录。我想出了如何通过将changelog移动到第二个:toctree::来实现它，但是这有一些奇怪的行为。主要是，当我访问页面时，changelog会出现在不同的项目列表中，当我使用侧栏导航时，我只能在每个toctree中导航(如果我单击changelog，就不会在侧边栏上显示其他部分)。我现在要说的是： :maxdepth: 5 getting

浏览 0提问于2019-05-18得票数 9

1回答

如何将外部文件和索引中的部分都包含到sphinx目录中？

python、python-sphinx、tableofcontents、toctree

我正在使用sphinx构建我的python包文档，但是我在向目录中添加来自docs文件夹中的其他文件和index.rst上的其他部分的条目时遇到了一些麻烦。=============== 对introduction部分的第二个引用有效，但toctree上的第一个引用不起作用。如

浏览 14提问于2019-11-09得票数 0

2回答

如何在狮身人面像运行时预处理源文件？

python、python-3.x、vhdl、python-sphinx、read-the-docs

我已经为我的项目设置了Sphinx文档，并希望提取源文件的文档字符串并将它们嵌入到最终文档中。不幸的是，Sphinx不支持源文件的语言(VHDL)。VHDL似乎没有狮身人面像域。因此，我的想法如下： Python代码从每个源文件(最顶层的多行注释块)中提取文本块，每个源文件组装一个reST文件，包括这个注释块和其他一些所有源文件都列在一个index.rst中，以生成.. toctree::指令。

浏览 2提问于2016-05-24得票数 11

回答已采纳

1回答

Sphinx错误:未知指令类型"automodule“或"autoclass”

python-sphinx、autodoc

我需要使用Sphinx记录我的Python项目。但我不能用autodoc。当我配置我的项目时，我选择了“扩展autodoc”选项，但现在如果我使用我得到一个错误： sphinx-quickstart on Thu Nov 22 15:24:42 2012.You can adapt this file

浏览 0提问于2012-11-23得票数 86

回答已采纳

点击加载更多