sphinx readTheDocs主题文件夹结构

Question

我想创建我的讲义的数字版本。我安装了sphinx并更改了config.py文件，以便ReadTheDocs主题正常工作。

我希望有类似的结构，如以下屏幕截图（来自Read the Docs Documentation）

我的index.rst看起来像

.. Lectures documentation master file, created by
   sphinx-quickstart on Tue Jan  9 20:20:10 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

iLectures
======================================

Hello!

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   intro

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

我如何更改index.rst以具有类似截图中的类似结构？如果我可以在我的网站上拥有与导航中相同的文件夹结构，那也是非常好的？如何引用不在同一目录中的文件？我非常感谢任何帮助。 尝试在intro之后缩进新内容，但这只会导致错误。

Answer 1

阅读文档的存储库有一个docs目录，它提供了如何根据需要渲染导航的示例。以下是对正在发生的事情的解释。

导航屏幕截图由两个文件yaml-config.rst和index.rst生成。在后者中，您会看到它引用了toctree directive下面的yaml-config.rst。

.. toctree::
   :maxdepth: 2
   :caption: User Documentation

   getting_started
   versions
   builds
   features
   support
   faq
   yaml-config
   guides/index
   api
   embed

index.rst文件描述了整套文档的文件结构，并在导航中表示为maxdepth 2。 {1}}文件由Sphinx解析并呈现导航节点＆＃34;阅读文档YAML配置＆＃34;。