blocks|key|1117404|text|对于狮身人面像中的目录，您应该使用toctree|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|1117405|..+toctree::
+++:maxdepth:+2

+++doc1
+++doc2
+++etc..|code-block|syntax|javascript|1117406|如果生成所有文档，那么使用"globbing“自动包含所有内容是很好的：|1117407|..+toctree::
+++:maxdepth:+2
+++:glob:

+++*|1117408|有关更多详细信息，请参阅博士关于toc|1117409|下面是cython文档中的一个例子|1117410|​|1117411|📷|atomic|1117412|1117413|这是一个index.rst文件|1117414|1117415|1117416|entityMap|0|LINK|mutability|MUTABLE|url|https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#table-of-contents|1|https://cython.readthedocs.io/en/latest/#|2|IMAGE|IMMUTABLE|imageUrl|https://developer.qcloudimg.com/http-save/yehe-900000/c1da2d897915cdf91e4f25818f1bc749.png|imageAlt|3|https://raw.githubusercontent.com/cython/cython/master/docs/index.rst|4|https://developer.qcloudimg.com/http-save/yehe-900000/0ba670e025cc66dc1db93bd6a0ba1bcc.png^0|H|7|0|0|0|0|C|7|0|0|3|8|1|0|0|0|1|2|0|0|4|B|3|0|0|1|4|0|0^^$0|@$1|2|3|4|5|6|7|1M|8|@$9|1N|A|1O|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|1P|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|1Q|8|@]|D|@]|E|$]]|$1|M|3|N|5|H|7|1R|8|@]|D|@]|E|$I|J]]|$1|O|3|P|5|6|7|1S|8|@]|D|@$9|1T|A|1U|1|1V]]|E|$]]|$1|Q|3|R|5|6|7|1W|8|@]|D|@$9|1X|A|1Y|1|1Z]]|E|$]]|$1|S|3|T|5|6|7|20|8|@]|D|@]|E|$]]|$1|U|3|V|5|W|7|21|8|@]|D|@$9|22|A|23|1|24]]|E|$]]|$1|X|3|T|5|6|7|25|8|@]|D|@]|E|$]]|$1|Y|3|Z|5|6|7|26|8|@]|D|@$9|27|A|28|1|29]]|E|$]]|$1|10|3|V|5|W|7|2A|8|@]|D|@$9|2B|A|2C|1|2D]]|E|$]]|$1|11|3|T|5|6|7|2E|8|@]|D|@]|E|$]]|$1|12|3|-4|5|6|7|2F|8|@]|D|@]|E|$]]]|13|$14|$5|15|16|17|E|$18|19]]|1A|$5|15|16|17|E|$18|1B]]|1C|$5|1D|16|1E|E|$1F|1G|1H|-4]]|1I|$5|15|16|17|E|$18|1J]]|1K|$5|1D|16|1E|E|$1F|1L|1H|-4]]]]

For a table of contents in Sphinx you should use <code>toctree</code>:
<pre><code>.. toctree::
 :maxdepth: 2

 doc1
 doc2
 etc..
</code></pre>
And if you generate all docs, then it's nice to use &quot;globbing&quot; to include everything automatically:
<pre><code>.. toctree::
 :maxdepth: 2
 :glob:

 *
</code></pre>
For more details look into the <a href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#table-of-contents" rel="nofollow noreferrer">docs about toc</a>
<hr />
here's an example in <a href="https://cython.readthedocs.io/en/latest/#" rel="nofollow noreferrer">cython docs</a>
<a href="https://i.stack.imgur.com/1Fqrx.png" rel="nofollow noreferrer"><img src="https://i.stack.imgur.com/1Fqrx.png" alt="enter image description here" /></a>
and here's an <a href="https://raw.githubusercontent.com/cython/cython/master/docs/index.rst" rel="nofollow noreferrer">index.rst file</a>
<a href="https://i.stack.imgur.com/fTNYH.png" rel="nofollow noreferrer"><img src="https://i.stack.imgur.com/fTNYH.png" alt="enter image description here" /></a>

I have some sphinx documentation inside my <code>docs/</code> folder. There I have a typical structure of some handwritten and dynamically generated documentation from code (Python). I would like to have a very simple <code>README.rst</code> for people opening the repo. In that <code>README.rst</code> I would like to have the whole TOC displayed of the Sphinx documentation. It would look something like that:
<pre><code>
About section etc.
==================

blah blah blah

For more check out the documentation

.. here the automatically imported TOC tree
</code></pre>
How can I do that?

How to link a Table of Contents (TOC) from index.rst to README.rst?

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云AI代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

功能1上新10个字符

功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符。

功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符。

功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符

功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符

功能4上新

文章&问答评论现已支持表情

全新交互，全新视觉，新增快捷键、悬浮工具栏、高亮块等功能并同时优化现有功能，全面提升创作效率和体验

社区富文本编辑器全新改版！诚邀体验～ 

精选全网热门MCP server，让你的AI更好用 🚀

💥开发者 MCP广场重磅上线！

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

社区新版编辑器体验调研

我的docs/文件夹中有一些狮身人面像的文档。在这里，我有一些手写和动态生成的代码文档(Python)的典型结构。我想有一个非常简单的README.rst为人们打开回购。在该README.rst中，我希望显示狮身人面像文档的整个TOC。它看起来会是这样的：About section etc.==================blah blah blahFor more check out the

问如何将目录从index.rst链接到README.rst？
EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何将目录从index.rst链接到README.rst？EN