使用Sphinx的ReadTheDocs Theme文件夹结构。

Question

我想创建一个数字版的讲义。我安装了sphinx，并修改了config.py文件，这样ReadTheDocs主题就可以工作了。

我希望有一个类似于下面截图的结构（来自于 阅读文件 文档)

我的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. 在后者中，你会看到它引用了 yaml-config.rst 在下面 toctree 指令.

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

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

该 index.rst 文件描述了整套文件的文件结构，并在导航中表示，以一个 maxdepth 的 2. 该 yaml-config.rst 文件被Sphinx解析，并在 "阅读文件YAML配置 "下渲染导航节点。