如何在Sphinx latex中将toctree中包含的rst内容放在父内容之后

在Sphinx latex中，可以通过使用toctree的includehidden选项来将toctree中包含的rst内容放在父内容之后。

toctree是Sphinx中用于生成文档目录的指令。默认情况下，toctree会按照rst文件中的顺序将子内容放在父内容之前。但是，通过设置includehidden选项为true，可以将toctree中包含的rst内容放在父内容之后。

下面是一个示例：

.. toctree::
   :maxdepth: 2
   :caption: 目录

   parent
   child1
   child2
   child3

在上面的示例中，toctree指令包含了四个子内容：parent、child1、child2和child3。默认情况下，这些子内容会在目录中出现在toctree指令之前。但是，如果将includehidden选项设置为true，子内容将会在toctree指令之后出现。

.. toctree::
   :maxdepth: 2
   :caption: 目录
   :includehidden:

   parent
   child1
   child2
   child3

通过上述设置，子内容将会在目录中出现在toctree指令之后。

对于Sphinx latex中的toctree，可以通过设置includehidden选项来控制子内容的位置。这样可以更好地组织文档结构，使得父内容和子内容之间的关系更加清晰。

关于Sphinx和latex的更多信息，可以参考腾讯云的产品文档：

Sphinx产品介绍

LaTeX产品介绍

页面内容是否对你有帮助？

有帮助

没帮助

相关·内容

sphinx入门指南【1】快速入门

简介 sphinx是一个用于快速生成文档的工具，非常适合生成Python文档。它具有以下优点：支持多种输出格式，如html，Latex，ePub等。...安装使用pip进行安装： pip install sphinx 设置源文件目录包含.rst文件的根目录称之为源文件目录，目录中还包含sphinx的配置文件conf.py。...进入源文件目录，执行以下命令，会指引用户配置整个项目： sphinx-quickstart 定义文件结构执行上述命令之后，sphinx会在源文件目录中自动生成conf.py文件以及index.rst。...index.rst称之为主文档，它被sphinx作为欢迎页面。 index.rst中包含了目录树指令toctree，sphinx使用它链接其他子文档。...对象文档 sphinx的设计初衷之一就是更容易生成任何域中对象的文档，域指很多对象的集合，这些对象中还包含了相应的文档注释。

2.1K4 0

用Sphinx快速制作文档

下面列出了其良好特性,这些特性在Python官方文档中均有体现: 丰富的输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages（...可自动生成美观的模块索引精确的语法高亮: 基于 Pygments 自动生成语法高亮开放的扩展: 支持代码块的自动测试,并包含Python模块的自述文档(API docs)等 Sphinx 使用...的主要功能是被转换成欢迎页, 它包含一个目录表（ “table of contents tree”或者 toctree )....注：文档文件放在与index.rst同级目录下。支持markdown文件、更改文档主题 Spinx本身不支持.md文件生成文档，需要我们使用第三方库recommonmark进行转换。...pip install recommonmark pip install sphinx_rtd_theme 安装好，在conf.py中修改下列两个配置： source_suffix = ['.rst'

1.8K6 0

Sphinx补篇

也就是说，如果您的目录包含一堆reST格式的文档（可能还有文档的子目录）以及），Sphinx可以生成结构良好的HTML文件（在其他目录中），以方便浏览和导航。...但是从同一来源，它还可以生成LaTeX文件，也可以将其编译为文档的PDF版本，或者直接使用rst2pdf编译为PDF文件。 ?...就是这个文件,事实上这个文件也可以是txt文件.但是我就写rst,咋啦 ? 就像这样 ---- 在命令选项板（Ctrl-Shift-P或Cmd-Shift-P）中输入命令，并在表语法中使用光标位置。...要在LaTeX文档中使用这些颜色，只需\usepackage[svgnames]{xcolor}在你的序言中添加颜色，然后使用\color{}命令（例如\color{Navy}）选择一种颜色，之后所有文本将为你指定的颜色...这个内容有点超纲,latex的渲染是学术界的共识,我之后会讲这个.假如我写论文的话. https://sphinx-doc-zh.readthedocs.io/en/latest/config.html

1.1K1 0

Sphinx+gitee+Read the Docs搭建在线文档系统

. > Separate source and build directories (y/n) [n]: y <--------这里选y表示编译的文件单独放在build中 The project name...的配置，如主题配置等 index.rst：文档项目起始文件，用于配置文档的显示结构 cmd.bat：这是自己加的脚本文件（里面的内容是‘cmd.exe’）,用于快捷的打开windows的命令行 make.bat...需要修改index.rst文件，首先来看一下这个文件中的内容： .....然后编辑soure/Cpp文件夹里的index.rst文件，这里表示该目录级别下，又包含了3个子目录，子目录中再次通过index文件来描述子目录中的文档结构： C++知识 ===============...soure/Cpp/01设计模式中的index.rst文件内容如下，这里表示管理了2个文档设计模式 ================================= .. toctree::

1.8K3 0

ReStructuredText 文档编写全攻略编写文档说明

将 rst 格式的文件转换成 html 等格式的文件，方便托管在服务器上，进行访问，依赖的工具有：sphinx sphinx 介绍 sphinx 是一个基于python的文档生成工具，许多 python...，遇到问题再针对性的查找：比如：如何在文档内提供下载链接，点击链接就能进行下载 gitbook的使用 Gitbook 和 sphinx 有很多相似之处：自动的生成文档使用标记语言：gitbook...使用 markdown、sphinx 使用 rst 文档的结构组织方式很相似：gitbook 是 SUMMARY.md 、sphinx 使用的文件是 index.rst 安装 gitbook 客户端...gitbook serve 编译和预览书籍内容和结构编写rst文档的流程 python sphinx 编写文档组织文档结构 make html 查看效果 1....之后文件目录结构如下： _build/ _static/ _templates/ conf.py* index.rst make.bat Makefile 其中： conf.py 是配置文件

5.5K3 1

使用 Python 30分钟教你快速搭建一个博客

source：文件夹：你的文档源文件全部应全部放在source根目录下。 Makefile：编译文件。完全不用管。 make.bat：bat脚本。你也不用管。...03 配置及扩展 ---- Sphinx 的配置文件是 source\conifg.py 由于修改的内容比较多而杂，为了使这个搭建过程，更加顺畅。小明已经给你精心准备了一份配置文件。...你只要关注我的公众号，后台直接回复「Sphinx」即可获取。关于配置文件，我做了哪些事：配置主题支持LaTeX 支持中文检索以上配置文件，需要搭配扩展模块才能使用。...在source目录下，新增文件 how_to_be_a_rich_man.rst（至于什么是rst格式呢，请自行搜索引擎噢）文件内容如下第一章如何成为有钱人 ===================...这里要提醒一下的是，Sphinx的文档格式，默认是 rst 格式，如果你习惯了使用Markdown来写文章，可以使用 Pandoc 这个神器转换一下。这里给出转换命令。

1K2 0

5步搭建一个测试文档管理网站

编写第一个文档现在开始就可以创建真正的文档了，具体需要3步： 1.在source目录下创建一个.rst的文件，如：hello.rst2.文件内容为rst格式文本3.修改source/index.rst...文件，添加新增的hello.rst文件 hello.rst文件内容如下： hello, python ============== index.rst文件修改如下： Contents: .. toctree...html_theme内容为 html_theme = "sphinx_rtd_theme" 之后，再次执行make html命令重新编译一下。...，并在source目录下创建一个markdown.md文件，其内容如下： # Test Markdown ## header 1 ### header 2 重新执行make html之后，再次访问网页的效果如下...当然，官方支持的reStructuredText语言，能够支持的格式会更多。比如：markdown中的表格就不被支持。

7602 0

使用python编写量子线路打印的简单项目，并使用Sphinx自动化生成API文档

一般一个python项目的文档有两部分组成：一部分是用markdown撰写的使用说明文档，其宗旨在于概述的介绍整个项目的重点内容，以及可能包含少部分的使用示例。...我们先点击这里的index和module看看内容，分别为下列的两个图所示： ? ? 最后在这个索引列表中我们点击进入qcprinter这个类中，去查看详细的类的文档说明： ?...相应的函数注释内容也会在接口文档中体现： ? 需要注意的是，如果相关的类或者函数是受保护的类型，那么在sphinx生成的文档中是不会显示的(构造过程中自动忽略)。...在上述示例中，src/hiqfermion是源代码的存放地址，而docs/source是生成的rst文件存放的位置。一般我们需要先生成这些rst文件，再使用sphinx-build执行文档构建。..... toctree:: :maxdepth: 4 module2 这里rst文档会自动搜寻同目录下的module1.rst和module2.rst文件，并自动化的生成文档。

2.9K2 0

Sphinx初尝

下面列出了其良好特性,这些特性在Python官方文档中均有体现: 丰富的输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages（...man 文档）, 纯文本完备的交叉引用: 语义化的标签,并可以自动化链接函数,类,引文,术语及相似的片段信息明晰的分层结构: 可以轻松的定义文档树,并自动化链接同级/父级/下级文章美观的自动索引:...可自动生成美观的模块索引精确的语法高亮: 基于 Pygments 自动生成语法高亮开放的扩展: 支持代码块的自动测试,并包含Python模块的自述文档(API docs)等 Sphinx 使用 reStructuredText...的详细信息 https://www.sphinx-doc.org/en/master/usage/configuration.html 这个是配置文件可以看到是和我创建文件的时候的内容相符 https:...pip install recommonmark pip install sphinx_rtd_theme 安装好，在conf.py中修改下列两个配置： source_suffix = ['.rst'

1.6K2 0

围绕Sphinx搭建代码化的内容管理+文档开发系统 | 技术传播

在此之前，我一直以为部署一套这样的系统，非得采购专门工具不可；万万没想到，一个免费开源的工具，竟然可以做到如此交付水平；而且完全不需要开发者掌握专门的xml/dita格式，只需要配合通用性更高的rst/...执行发布命令，或者运行发布脚本，即可发布为多种目标格式的文档，如Web或PDF。考虑到文章篇幅不宜过长，具体实施落地的操作方法就不展开说明了。...围绕Sphinx构建整个内容管理、文档开发和系统集成，几乎可以完全参照代码开发的系统构建：使用VSCode进行源码编写；使用Git进行内容和版本管理；使用Sphinx进行文档发布；使用Jenkins...在这里，只有一点需要特别说明的是：如果想对Sphinx直出的PDF进行一定人工干预，如添加企业LOGO，或者应用自定义样式之类，那么，从源码到PDF之间，可以被编辑的中间文件，并不是我们所熟悉的Word...对于之前从来没有使用过Latex的开发者而言，前期势必会引入一些学习成本；但由于Latex同样是一种代码化的开发方式，在完成基本的模板设计后，完全可以通过Jenkins部署自动化地实现干预。

721 0

构建自己的Python开源包

文件中。...',['file1',file2']),('文件要放入的文件夹2',['file3',file4'])] 第一个元素指最后在文件要放的位置/目录，如果空字符，表示放在根目录，第二个元素指原文件所在的位置...'data': ['data/*.dat'], # 包含data包data文件夹中的 *.dat文件 } 写好setup.py文件，可以python setupy install进行安装测试。...编写文档编写README.md和说明文档docs，这里我们用sphinx库来创建文档架构，sphinx是一个智能、漂亮的文档生成工具。...初始化docs文件夹 sphinx-quickstart 编写rst文件，运行make html即可生成html文档, rst文档例子： Welcome to BaiduMapAPI's documentation

1K2 0

RST文件打开_rpt文件

RST与Python类似Javadoc与Java，如果下载了别人的Python源码，里面有rst文件夹，我们可以转为html后用浏览器打开，具体为：安装python的sphinx模块：...pip install sphinx,我装的anaconda,其中已经有了，那么在cmd中进入rst的父文件夹，输入： sphinx-build -b html doc build doc是含有...rst的目录，build是输出html的目录如果提示缺少sphinx_rtd_theme，就pip install sphinx_rtd_theme : ) 运行完后就可以在浏览器里查看了，一般从...版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。...如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至举报，一经查实，本站将立刻删除。

3.1K2 0

reStructuredtext快速入门

在必要的时候，.rst文件可以被转化成PDF或者HTML格式，也可以有Sphinx转化为LaTex,man等格式，现在被广泛的用于程序的文档撰写。...标记需注意的一些限制: 不能相互嵌套内容前后不能有空白: 这样写* text* 是错误的, 如果内容需要特殊字符分隔....列表下面可以插入任意的内容, 段落, 图片都可以, 只要他们的左侧和列表的第一个文字左对齐。...及上划线表示部分 * 及上划线表示章节 =, 小章节 -, 子章节 ^, 子章节的子章节 ", 段落显示标记显式标用在那些需做特殊处理的reST结构中, 如尾注，突出段落，评论，通用指令....也是reST 的扩展规则, 在 Sphinx 经常被用到。

1.5K2 0

四个 Python 项目管理的构建工具

，如 tox, wheel, coverage, sphinx, flake8, 它们都可以通过 pip 来安装。...之后就可以 make test, make coverage, make docs，make dist 等。其中 make docs 可以生成一个很漂亮的 Web 文档。 ...这样创建了一个 Python 项目，目录结构与前面 cookiecutter 所选的模板差不多，只不过它把源文件放在了 src 目录，而非 sample 目录。...poetry run pytest # 运行使用 pytest 的测试用例，如 tests/test_sample.py 4. ...在 sample 目录(与 pyproject.toml 文件平级)中创建文件 my_module.py, 内容为 def main(): print('hello poetry') 然后在 pyproject.toml

1.7K2 0

4 个Python项目管理与构建工具，建议收藏！

，如 tox, wheel, coverage, sphinx, flake8, 它们都可以通过 pip 来安装。...之后就可以 make test, make coverage, make docs，make dist 等。其中 make docs 可以生成一个很漂亮的 Web 文档。...这样创建了一个 Python 项目，目录结构与前面 cookiecutter 所选的模板差不多，只不过它把源文件放在了 src 目录，而非 sample 目录。...poetry run pytest # 运行使用 pytest 的测试用例，如 tests/test_sample.py 4....在 sample 目录(与 pyproject.toml 文件平级)中创建文件 my_module.py, 内容为 def main(): print('hello poetry') 然后在

1.2K3 0

4 个 Python 项目管理与构建工具，建议收藏！

，如 tox, wheel, coverage, sphinx, flake8, 它们都可以通过 pip 来安装。...之后就可以 make test, make coverage, make docs，make dist 等。其中 make docs 可以生成一个很漂亮的 Web 文档。...这样创建了一个 Python 项目，目录结构与前面 cookiecutter 所选的模板差不多，只不过它把源文件放在了 src 目录，而非 sample 目录。...poetry run pytest # 运行使用 pytest 的测试用例，如 tests/test_sample.py 4. ...在 sample 目录(与 pyproject.toml 文件平级)中创建文件 my_module.py, 内容为 def main(): print('hello poetry') 然后在 pyproject.toml

8783 0

Python 项目管理与构建工具

，如 tox, wheel, coverage, sphinx, flake8, 它们都可以通过 pip 来安装。...之后就可以 make test, make coverage, make docs，make dist 等。其中 make docs 可以生成一个很漂亮的 Web 文档。...这样创建了一个 Python 项目，目录结构与前面 cookiecutter 所选的模板差不多，只不过它把源文件放在了 src 目录，而非 sample 目录。...poetry run pytest # 运行使用 pytest 的测试用例，如 tests/test_sample.py 4....在 sample 目录(与 pyproject.toml 文件平级)中创建文件 my_module.py, 内容为 def main(): print('hello poetry') 然后在

5672 0

手把手教你给项目添加文档

构建文档导入项目之后，我们点击Build version即可成功创建文档 ? 等待片刻后即可构建完成，Webhook自动添加之后只要更新GitHub仓库，项目文档就会自动重新构建。 ?...然后我们就能够看到文档的雏形 ? 添加文档在做完上述前期工作之后，我们要来动手书写自己的文档。...', '.md'] 我们可以通过在项目根目录执行下述命令在本地生成html文件 make html 并且在build/html/index.html中来预览项目文档 ?...最后，我们只需要修改index.rst文件便可以修改文档内容，reStructuredText 是扩展名为.rst的纯文本文件，含义为"重新构建的文本"，其是轻量级标记语言的一种，被设计为容易阅读和编写的纯文本...参考资料 Quick reStructuredText：https://docutils.sourceforge.io/docs/user/rst/quickref.html Sphinx： https

9161 0

Python项目结构布局

从实际角度来看，“结构”意味着创建清晰的代码，其逻辑和依赖关系清晰明了，以及文件和文件夹在文件系统中的组织方式。哪些函数应该放入哪些模块？数据如何在项目中流动？哪些功能和函数可以被分组并隔离？...sample/helpers.py: 包含辅助功能的文件，可能被核心代码引用。 docs/conf.py: 项目文档的配置文件，通常与Sphinx文档生成工具一起使用。.../sample/ 如果模块只包含一个文件，则可以将其直接放在存储库的根目录中： ./sample.py License ./LICENSE 除了源代码本身之外，这可以说是存储库中最重要的部分。...同时，除了存储库的LICENSE文件，许可证信息通常也包含在代码文件的顶部注释中，以提醒开发人员和用户知晓项目的许可条件。...文档通常使reStructuredText（.rst）或Markdown等标记语言编写。使用工具如Sphinx可以将这些标记转换为漂亮的HTML文档或其他格式的文档。

3605 0

CMake 秘籍（七）

运行 Doxygen 将提取这些注释并在 Doxyfile 配置文件中定义的格式中创建文档。Doxygen 可以输出 HTML、XML，甚至是 LaTeX 或 PDF。...我们将在后面讨论其内容： include(UseDoxygenDoc) 然后我们添加src子目录： add_subdirectory(src) src子目录中的CMakeLists.txt文件包含以下构建块...，以纯文本 reStructuredText 格式，index.rst，以及一个 Python 模板文件，conf.py.in，用于 Sphinx 的设置。...如何操作与之前的食谱相比，我们将修改根CMakeLists.txt文件，并实现一个函数（add_sphinx_doc）：在将cmake文件夹附加到CMAKE_MODULE_PATH之后，我们如下包含...紧随code-reference的文件包含 Breathe 指令，以在 Sphinx 中包含 Doxygen 生成的文档： Messaging classes ================= Message

770 0

点击加载更多

扫码

添加站长进交流群

领取专属 10元无门槛券

手把手带您无忧上云