创建内容¶
除了自动生成的模块文档之外,还应该考虑创建项目文档。虽然,将docstring呈现为格式良好的页面是很好的,但是您仍然应该有一些常规页面来介绍您的项目并添加额外的上下文,如图表。
更新索引¶
docs/source/index.rst文件是项目文档的登录页。
最初它看起来像这样:
Welcome to <PROJECT_NAME>'s documentation!
=======================================================
Contents:
.. toctree::
:maxdepth: 2
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
在“:maxdepth:2”下面的一行添加附加RST文件的名称(不带文件扩展名)。一定要保留3个空格的缩进。见: Example