如何在不添加新文档的情况下在Sphinx toctree中添加标题？
在Sphinx中，可以通过使用toctree的maxdepth参数来控制在不添加新文档的情况下在Sphinx toctree中添加标题。toctree是Sphinx中用于生成文档目录的指令。
toctree指令可以在.rst文件中使用，用于指定要在目录中包含的文档。默认情况下，toctree会显示所有文档的标题。如果要在不添加新文档的情况下添加标题，可以使用maxdepth参数来限制toctree的深度。
以下是一个示例：
.. toctree:: :maxdepth: 2
document1 document2 document3
在上面的示例中，toctree指令包含了三个文档：document1、document2和document3。通过设置maxdepth参数为2，只会显示这三个文档的标题，而不会显示它们的子标题。
这样做的优势是可以控制目录的深度，使得目录更加清晰和易于导航。适用场景包括大型文档项目或者需要对目录进行精细控制的情况。
腾讯云提供了一款名为腾讯云文档的产品，可以用于托管和管理文档。您可以使用腾讯云文档来创建和组织您的文档，并且可以通过自定义模板和样式来美化文档。腾讯云文档还提供了丰富的协作和版本控制功能，方便团队协作和文档管理。
腾讯云文档产品介绍链接地址：https://cloud.tencent.com/product/tcd
请注意，以上答案仅供参考，具体的解决方案可能因您使用的具体工具版本和配置而有所不同。建议您查阅相关工具的官方文档或者咨询相关专业人士以获取准确的解决方案。
相关·内容
1回答
在图库树中插入文档时，显示的链接是文档的主要标题。所以当我这么做的时候
.. toctree::
materials/diffuse
materials/glossy
materials/specular
我得到：
材料
漫射材料
光泽度材料
镜面材料
“材料”一词在图克树中显然是多余的，但在文件标题中对良好理解很重要。
RST允许我这样写：
.. toctree::
Diffuse<materials/diffuse>
Glossy<materials/glossy>
Specular<materials/
浏览 0提问于2015-09-03得票数 11
我已经将Sphinx配置为使用markdown文件。 在我的index.rst文件中 .. toctree::
:maxdepth: 2
:caption: Contents:
documents/Markdown 在Markdown.md中，我有 # Markdown
## H2 Heading 当我渲染主页时，H2标题出现在toctree中。 ? 我还有我的toctree的其他部分，我想让:maxdepth大于1。为什么sphinx读取H2标题作为toctree的一部分，我如何才能让它停止这样做，而不必将:maxdepth设置为1？
浏览 27提问于2019-02-21得票数 0
回答已采纳
我有一个git存储库，其中包含多个跟在名称空间后面的包(即。
我正在尝试使用Sphinx创建一个ReadTheDocs文档。
git存储库如下所示：
为了在我的本地机器上测试它，我使用了Sphinx的docker镜像sphinxdoc/sphinx。
我尝试使用不同的方法为我的所有包生成文档，但每种方法都有不同的问题。
sphinx apidoc
docker run -it -v pwd:/repo --rm rtd bash -c 'make clean && rm -rf /repo/docs/_source/* && sphinx-apidoc
浏览 8提问于2021-02-05得票数 1
2回答
我有一个.. toctree作为sphinx页面的一部分，其中包括到包中其他rst文件的相对链接。我如何包括一个链接到一个给定页面的分段，而不是完整的页面本身？
我试了一下
.. toctree::
page#section
但那不管用。任何帮助都是很棒的。
浏览 4提问于2013-10-30得票数 17
回答已采纳
1回答
我希望Sphinx文档的左边菜单有我的项目的模块，我想从主模块的__init__.py文件中定义这个内容。这就是我想要做的：
__init__.py
'''
Components platform:
--------------------
* language: python
* rest framework: flask-restful
* testing: pytest
* documentation: sphinx
.. toctree::
:maxdepth: 1
:caption: Contents:
.. automodule::
浏览 0提问于2021-04-12得票数 0
2回答
我已经为我的项目设置了Sphinx文档，并希望提取源文件的文档字符串并将它们嵌入到最终文档中。不幸的是，Sphinx不支持源文件的语言(VHDL)。VHDL似乎没有狮身人面像域。
因此，我的想法如下：
钩入Sphinx，运行并在Sphinx之前执行一些Python代码
Python代码从每个源文件(最顶层的多行注释块)中提取文本块，每个源文件组装一个reST文件，包括这个注释块和其他一些reST标记。
所有源文件都列在一个index.rst中，以生成.. toctree::指令。
每个源代码目录都递归地进行文本提取和转换。
因此，主要的问题是：如何连接到Spinx?
还
浏览 2提问于2016-05-24得票数 11
回答已采纳
好的，我正在使用Sphinx Autosummary为一些类生成文档。有三种不同类型的类，我希望我的侧边栏有三个不同的部分，就像我在toctree指令中使用:caption:选项一样。 因此，我添加了将autosummary指令分隔为三个较小的指令，并在它们之间放置一个隐藏的toctree，如下所示： Section 1
.. toctree::
:hidden:
:caption: Section 1
.. autosummary
:toctree: stubs
myclass
anotherclass
Section 2
.. toctree::
浏览 23提问于2019-12-14得票数 1
有没有人知道按文件名降序排列toctree的选项？如果是升序，我们可以使用:glob:选项，如下所示：
.. toctree:
:glob:
2011*
对于应该在Sphinx文档中报告的重构文本编写的每日笔记，这将非常方便。
浏览 1提问于2011-11-30得票数 12
回答已采纳
我们正在考虑在我工作的地方使用Sphinx，它似乎可以做我们需要的一切。然而，我有问题让它匹配所需的公司模板，这需要有一些前置网页插入之间的标题页和目录。
如果文本位于.rst文件中主目录的上方，则在HTML输出中将其置于目录上方，但在pdf输出中将其移至目录下方。我还尝试添加一个隐藏的toc，但也不起作用。内容也被放在非隐藏的目录之后。
.. toctree::
:hidden:
frontmatter
.. toctree::
:maxdepth: 2
contents_of_document
我知道这是必须的，因为人们已经使用这个工具出版了书籍，但我不知道
浏览 1提问于2016-04-24得票数 2
我正在写我的项目使用sphinx的文档，我想把模块的链接放在侧栏。我可以把链接放在首页，但不能放在侧栏上。
index.rst的代码
.. DashBoard documentation master file, created by
sphinx-quickstart on Tue Dec 12 12:09:02 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to DashBoard&#
浏览 10提问于2017-12-13得票数 0
2回答
我刚刚使用带有sphinx-quickstart.exe主题的alabaster创建了一个狮身人面像文档。
我想在标题的某个地方打印这份文件的版本。
我在version和release变量中填充了conf.py
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
# -- Project information -----------------------------------------------------
project = 'MWE'
copy
浏览 0提问于2019-02-05得票数 2
回答已采纳
2回答
我是Sphinx的新手，我想编写Python包的文档。当我想要包含一个演示文件时，我遇到了问题。
我想使用扩展名demo.ipynb包括文件nbsphinx。它已成功安装在我的计算机上。狮身人面像的conf.py文件中的扩展名变量包含以下行：
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinx.ext.githu
浏览 0提问于2019-03-22得票数 0
1回答
我正在使用Sphinx构建我的文档，以便与readthedocs.io一起使用。到目前为止，这一直运行得很好。我将自己定位于(在我看来)优秀的文档。
因为我欣赏godot文档中的标题，所以我尝试复制这些标题，首先看看他们是如何做到这一点的。 (注:文档末尾有相关章节)
这似乎是合理的，因为他们使用了多个toctree，给每个toctree一个标题。
然而，当我做同样的事情时，sphinx似乎会自动给我的部分编号，这是我不想要的。目录树不包含:numbered:标记。
这是一个代码示例，解释了我的toctree原则上是如何构造的：
.. toctree::
:caption: Secti
浏览 4提问于2019-11-16得票数 0
我正在使用Sphinx (sphinx-1.2b1-py2.7)。我希望TOC出现在侧边栏中。它似乎是二元的:我只能在侧边栏和文本正文中获得一个TOC和一个项目符号列表，否则我什么也得不到(侧栏中没有TOC，项目符号列表也没有)。
当我像这样使用toctree指令时：
.. toctree::
:hidden:
Topic1
Topic2
结果:侧边栏中没有TOC，正文中没有带项目符号的主题列表。
当我像这样使用toctree指令时：
.. toctree::
Topic1
Topic2
结果:侧栏中的TOC和正文中带有项目符号的主题列
浏览 15提问于2013-06-19得票数 10
.. Documentation_hexnode documentation master file, created by
sphinx-quickstart on Mon May 09 14:24:54 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Frequently Asked Questions
========================================
浏览 0提问于2016-05-09得票数 0
2回答
我正在尝试制作一个新的Sphinx模板，它将为侧边栏创建一个自定义的toctree。
使用Jinja模板语言，似乎只有一个函数可用：toctree()，它一次显示所有toctree，但我需要遍历单个toctree项。
这看起来像这样：
{% for element in toctree_elements %}
{{ ... display the stuff as wanted }}
{% endfor %}
有可能吗？
浏览 3提问于2015-07-31得票数 2
2回答
我想使用Sphinx的和从docstring递归地生成API文档。我想要每个模块、类、方法、属性和函数的单独页面。但它根本没有检测到我的模板。实际上，如果我只是将module.rst文件从_templates/autosummary/中删除，那么整个文件的呈现方式与以前完全相同。我一直跟着去信。如果你感兴趣，。
编辑:它似乎确实生成了一个不同的文件，为了读取新模板，我不得不删除docs/_auto汇总。但是，现在它生成一个带有sparse头和description头的文件。它不会进入{% if classes %}和{% if functions %}指令。
我的目录结构如下：
稀疏
浏览 3提问于2018-01-03得票数 23
回答已采纳
如何修复狮身人面像底部的警告？
我正试图在狮身人面像中使用我的Python笔记。在与index.rst相同的目录级别上，我将我的笔记放在单独的文件中。
生成HTML后，我会收到以下警告
警告
/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree
在……里面
构建时的完整消息
sudo sphinx-build -b html ./ _build/html
Running Sphinx v0.6.2
loading pickled environment... done
浏览 4提问于2009-11-06得票数 2
回答已采纳
我需要Sphinx自动摘要扩展来使用:toctree: generated/生成存根，但我也想防止目录条目出现在HTML侧边栏中。考虑以下文档字符串： MySubPackage (mypackage.mysubpackage)
=====================================
Some Title
----------
.. currentmodule:: mypackage.mysubpackage
Some description
.. toctree::
:hidden:
:maxdepth: 1
mypackage.mysubp
浏览 76提问于2021-06-26得票数 0
2回答
我使用sphynx从静态.rst文件生成文档(没有文档字符串提取)。
我的存储库中有两个文件：
index.rst
.. toctree::
intro
和intro.rst
Will be skipped
===============
Where is my parent section?
---------------------------
Second section
==============
以下是通过运行sphinx-build -b latex . _build; cd _build; pdflatex *获得的pdf屏幕截图：
拉伤还是什么？
浏览 0提问于2015-01-15得票数 5
回答已采纳
2回答
我一直在使用Sphinx为我的代码编写一个很好的文档，我想知道是否可以在目录旁边放置一个图像(而不是没有任何东西的大空白)。
现在，我初学者的index.rst文件如下所示：
.. XXXXXX documentation master file, created by
sphinx-quickstart on Wed Apr 11 13:59:42 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directi
浏览 0提问于2018-04-13得票数 3
回答已采纳
1回答
只有在设置了某个标记时，我才希望将我的一个文件包含在Sphinx TOC中，但是显然的方法失败了：
.. toctree::
:maxdepth: 5
index
core
utils
oec
plotting
install
news
glossary
.. only:: private_version
todo
有什么简单的方法可以做到这一点吗？
浏览 3提问于2014-02-02得票数 6
我正在尝试使用sphinx-auto汇总来创建python代码的自动摘要，如下所示：
main
├───modA
| ├───__init__.py
| ├───modA.py
├───modB
| ├───__init__.py
| ├───modB.py
├───docs
| ├───build
| └───source
| ├───refs
| | |───_autosummary
| | |───index.rst
| | |───modA.rst
| | |───modB.rst
|
浏览 6提问于2020-06-06得票数 6
我正在尝试使用Sphinx为大型python代码库自动创建api文档。
我尝试过使用build_modules.py和sphinx-apidoc。无论使用哪种方法，我都可以在我的输出目录中成功地为包和顶级模块创建rst文档。
但是，当我使用
make html
它会给出数千个这种类型的错误：
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'rstDocs/src.Example1.class1.method1'
对于代码库中的每个类和方法。通过一些实验，
浏览 18提问于2012-08-31得票数 47
回答已采纳
使用来记录我的Python项目。我希望删除每个python文件名称后面的单词“”(在导航栏、TOC、页面标题等)。
例如详细信息：
该项目由utils.py和main.py两个文件组成。
在我的index.rst文件中，我使用：
.. toctree::
:maxdepth: 2
utils
main
将两个文件作为“模块”导入。然后在docs/文件夹中调用：
sphinx-apidoc -f -o ./source/ ..
make html
以生成静态站点。在网站中，“模块”这个词跟在每个文件名后面，我想删除它。
浏览 1提问于2018-05-16得票数 9
回答已采纳
1回答
我正在尝试用Python记录一个包。目前，我有以下目录结构：
.
└── project
├── _build
│ ├── doctrees
│ └── html
│ ├── _sources
│ └── _static
├── conf.py
├── index.rst
├── __init__.py
├── make.bat
├── Makefile
├── mod1
│ ├── foo.py
│ └── __init__.py
├── m
浏览 3提问于2014-08-28得票数 12
回答已采纳
我正在使用Sphinx为Python模块创建文档。
我很想在页面上添加字幕，但我不希望它们出现在树中。
我想要小的部分和简短的(几行)描述。将每个节标题添加到图库树中将使浏览文档变得更加困难。
这是我的index.rst
Welcome to ModernGL's documentation!
====================================
.. figure:: Examples/images/02_uniforms_and_attributes.png
:scale: 50 %
:alt: ModernGL
:align: cen
浏览 6提问于2017-06-01得票数 7
回答已采纳
在使用sphinx-rtd-theme时，我希望有一个指向侧栏中自动生成的索引的链接。我试过把它添加到树中：
.. toctree::
first
second
Index <:ref:`genindex`>
但这导致了
WARNING: toctree contains reference to nonexisting document u':ref:`geinindex`'
从狮身人面像没有其他效果。
我想我可以简单地在主题layout.html文件中硬编码索引，但是也许有更好的方法，而不是修改标准主题？
蒂娅有什么暗示！
浏览 5提问于2014-08-11得票数 25
回答已采纳
1回答
目前，我正在尝试使用sphinx来生成html格式的文档，但我发现一个问题是我无法使用搜索按钮来查找任何内容。我只是search一个关键字，结果不会是什么。我不知道为什么，我只是默认所有的东西。有人知道怎么修吗？
我在index.rst中写的是：
Contents:
.. toctree::
:maxdepth: 2
test.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
test.rst是：
================
eee
浏览 0提问于2012-08-09得票数 1
我被蟒蛇sphinx困住了。我的目录树如下所示：
| - project_root
| | - importable_project
| | | - importable_module.py
| | | - another_importable_module.py
| | | - Tutorials
| | | | - tutorial1.ipynb
| | - docs
| | | - build
| | | | - sphinx_build_files_and_folders
| |
浏览 2提问于2017-10-11得票数 0
回答已采纳
我正在用Sphinx制作一系列的设计文档，我希望将它们合并到一个toctree中，并将文档中的部分编号。我知道我可以使用.. sectnum::对子页面中的所有部分进行编号。但是，Sphinx/rst将页的标题(实际上只是第一节)和内容表编号为：
Table of Contents
1 Design the First
2 Design the Second
每个子页面看起来都是这样的：
1 Design the First
1.1 First Section
1.2 Second Section
我想要的是索引页面上的目录，其中只列出标题。
Table of Contents
浏览 3提问于2017-01-31得票数 9
我正在尝试将GNU并行的(无聊的) POD-html转换成狮身人面像。
我使用这个index.rst：
.. SPDX-FileCopyrightText: 2021 Ole Tange, http://ole.tange.dk and Free Software and Foundation, Inc.
..
.. SPDX-License-Identifier: GPL-3.0-or-later
.. GNU Parallel documentation master file, created by
sphinx-quickstart on Sat Jan 23 14:06:27
浏览 0提问于2021-07-12得票数 1
我是新来斯芬克斯的。
文件/home/user/myproject/docs/source/index.rst如下：
My project contents:
.. toctree::
:glob:
*
我收到以下有关在/home/user/myproject/docs/下运行$ make html的消息
checking consistency... /home/user/myproject/docs/source/design/index.rst:: WARNING: document isn't included in any toctree
我做错了什么？我希望
浏览 0提问于2012-03-02得票数 3
回答已采纳
我正在用Sphinx生成html文档。
如何修改文档中每个html页面的侧边栏，使其包含toctree？默认情况下，toctree似乎只显示在master_doc页面中，而且只显示在主区域，而不是侧边栏。
有什么简单的方法可以做到这一点吗？我将使用readthedocs来托管生成的文档，所以我倾向于避免使用任何第三方插件，除非readthedocs上也提供了这些插件。
浏览 1提问于2013-09-24得票数 47
回答已采纳
几天前，我开始使用Sphinx来记录python包，我得到的似乎是一个常见的错误，但我无法找到解决方案。
我用狮身人面像的快速启动来安排一切。我使用"doc/“作为文档根位置。包含我的包的文件夹设置为：
myfolder/
doc/
mypackage/
__init__.py
moprob.py
...
在快速启动之后，我在conf.py中编辑了路径如下：
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
然后，我在包中添加了一个
浏览 0提问于2017-07-19得票数 4
回答已采纳
1回答
我的Sphinx树中有许多.rst文件，它们被故意从任何索引树中排除。我会收到这样的警告
/filename.rst:: WARNING: document isn't included in any toctree
如何抑制Sphinx中的特定警告？
浏览 1提问于2012-10-17得票数 27
回答已采纳
假设我有一个包含以下来源的Sphinx项目：
index.rst
installation.rst
templating/
index.rst
module.rst
fieldtype.rst
index.rst (主页)具有以下目录树：
.. toctree::
:titlesonly:
installation
templating/index
我希望我的模板包括一个侧栏，列出所有3个顶级页面(主页，安装，模板/索引)。
我尝试在主页中添加第二个隐藏的TOC树：
.. toctree::
:hidden:
index
.. toc
浏览 33提问于2013-04-21得票数 31
回答已采纳
当我试图使用狮身人面像matlab域时，我无法让MWE工作，这是在上提供的
总是存在这个Can't import module错误。我猜想，扩展是从m代码中生成伪模块的，但据我所知，我实际上还不知道这种机制是如何工作的。
dir结构如下所示
root
|--test_data
| |--MyHandleClass.m
|
|--doc
|--------conf.py
|--------Makefile
|--------index.rst
文件MyHandleClass.m和index.rst包
浏览 3提问于2014-10-23得票数 2
TL，DR:从狮身人面像扩展，我如何告诉sphinx-build将一个附加文件作为依赖处理？在我的直接用例中，这是扩展的源代码，但是这个问题同样适用于扩展名所使用的一些辅助文件。
我正在使用自定义扩展使用Sphinx生成文档。我正在使用sphinx-build构建文档。例如，我使用这个命令生成HTML (这是sphinx-quickstart生成的makefile中的命令)：
sphinx-build -b html -d _build/doctrees . _build/html
由于我的自定义扩展与文档的源代码一起维护，所以我希望sphinx-build将其视为生成的LaTeX (和L
浏览 0提问于2019-02-04得票数 0
回答已采纳
以下代码使Sphinx自动摘要失败：
@dataclasses.dataclass
class Foo:
bar: int
class FooChild(Foo):
pass
我的自动摘要模板(_templates/autosummary/class.rst)：
{{ name | escape | underline}}
.. currentmodule:: {{ module }}
.. autoclass:: {{ objname }}
:members:
{% block attributes %}
{% if attributes %}
浏览 10提问于2022-04-11得票数 2
假设我有一个Sphinx索引文件
.. toctree::
foo
bar
而foo文件只有一个标题
***
Foo
***
All about foo.
而酒吧有两个
***
Bar
***
All about Bars.
******
Parrot
******
All about ex-parrots.
如果我将其编译成HTML，它将创建三个页面：index、foo和bar。但是，假设我希望Parrot有自己的HTML页面。是否有一种不分裂bar源文件的方法来实现这一点？
浏览 4提问于2016-01-21得票数 3
回答已采纳
1回答
我使用Sphinx+autodoc+autosummary为我的项目(mrpy)生成文档。
我正在做一个两层的总结，在index.rst中我有(最少)
mrpy
====
.. autosummary::
:toctree: _autosummary
:template: modules.rst
mrpy.stats
<other modules...>
如您所见，我为模块级的自动摘要使用了自定义模板。我这样做是为了让模块级的总结，我也得到了模块内的对象摘要，其中每个链接到自己的页面。作为参考，我的modules.rst文件是
{{ fullname }
浏览 2提问于2015-12-11得票数 3
回答已采纳
2回答
de index.rst没有问题，如下所示：
但是，当我转到另一个页面(在我的例子中是annotation-module.rst )时，侧栏选择并显示index和annotation-module，如下所示：
但是，我希望只有注释模块页面被激活并显示它的子部分。
我的conf.py只通过查找READTHEDOCS环境变量来使用html_theme，如下所示：
if not on_rtd: # only import and set the theme if we're building docs locally
try:
import sp
浏览 0提问于2018-07-22得票数 1
1回答
已重构文本目录子组
、、、
我正在尝试获取一个包含指向不同rst文件的子组的目录。这是我的index.rst： .. bonobo-trans documentation master file, created by
sphinx-quickstart on Fri Feb 8 18:09:07 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. toctree::
:maxdepth: 2
Tran
浏览 23提问于2019-02-11得票数 0
1回答
狮身人面像不识别子文件夹
、、、
我刚开始使用狮身人面像。只要我的文件在source顶部文件夹中，我就能够创建HTML文档。
一旦我将它们放到source directory的子文件夹中，Sphinx就不会将文档包含到构建中。Sphinx在生成测试文档后告诉我，测试文档不包括在内。因此，它会看到文件，但不包括它。
我错过什么了吗？我必须在index.rst文件或config.py中指定任何子文件夹吗？
我的index.rst文件：
Welcome to python help's documentation!
=======================================
.. toctree::
浏览 2提问于2017-08-01得票数 9
回答已采纳
我有一个Python项目，使用Sphinx作为文档。我正在readthedocs.io服务上远程构建文档。
我使用了sphinx-quickstart，它生成了一个具有以下链接的index.rst文件：
Indices and tables
~~~~~~~~~~~~~~~~~~
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
当我将更改推送到readthedocs.io并构建文档时，我的构建就成功了。我通过toctree指令手动链接的文档都可以正常工作。
search链接运行良好。
但是genindex链接到一个名为“索引”的空页面。
浏览 2提问于2020-11-05得票数 0
回答已采纳
我正在使用sphinx构建我的python包文档，但是我在向目录中添加来自docs文件夹中的其他文件和index.rst上的其他部分的条目时遇到了一些麻烦。
以下是my docs文件夹的内容：
$ ls docs/
api_reference.rst _build conf.py index.rst make.bat Makefile _static _templates
下面是来自index.rst的第一行：
Welcome to SPIN's documentation!
================================
This is the So
浏览 14提问于2019-11-09得票数 0
我想在Sphinx中给出一个量子公式。LaTeX代码： \ket{\psi}=\frac{1}{\sqrt{2}}(\ket{00}+\ket{11}) 看起来需要来自LaTeX的'physics‘包。如何在Sphinx中添加此包？ 我试图通过添加两行来修改Sphinx的conf.py。但它不起作用。 # -- Options for LaTeX output -------------------------------------------------
latex_engine = 'xelatex'
latex_elements = {'preambl
浏览 50提问于2021-01-18得票数 1
回答已采纳
我为我构建的库提供了一些基于Sphinx的文档，除了changelog之外，我还想显示我所有页面的扩展目录。我想出了如何通过将changelog移动到第二个:toctree::来实现它，但是这有一些奇怪的行为。主要是，当我访问页面时，changelog会出现在不同的项目列表中，当我使用侧栏导航时，我只能在每个toctree中导航(如果我单击changelog，就不会在侧边栏上显示其他部分)。有更好的方法吗？
我现在要说的是：
.. toctree::
:maxdepth: 5
getting_started
examples
modules
.. toctree::
浏览 0提问于2019-05-18得票数 9
sphinx-build修改了我的RST文件的格式，我不知道如何让它停止。只有在我运行make html，并且我的集成开发环境(PyCharm)没有进行格式化之后，才会发生这种情况。
在make html之前
General use plots
-----------------
.. autosummary::
:toctree: generated/
Study.plot_gene
Study.plot_event
在make html之后
General use plots
-----------------
.. autosummary::
:toctre
浏览 2提问于2014-11-04得票数 1
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
即时通信 IM
实时音视频活动推荐
腾讯云开发者
