带自动模块的Sphinx toctree

时间:2018-07-12 09:31:37

标签: documentation python-sphinx

我有一些模块要记录,因此目录位于主页面index上,而文档本身位于单独的页面中。我是自动文档和Sphinx的新手,但我已经接近了:

index.rst:

Documentation
*************

.. toctree::
   :maxdepth: 2

   Module1
   Module2

Index
=====
* :ref:`genindex`
* :ref:`modindex`

Module1.rst and Module2.rst:

Title
*****

.. automodule:: Module1 (or Module2)
   :noindex:
   :members:

使用noindex的原因是出现重复的对象描述错误。但是,这会阻止模块显示在toctree的{​​{1}}上。如何避免这种情况?看来这是一件基本的事情,但我无法解决。任何帮助将不胜感激!

似乎this question及其答案试图解决类似的问题,但是我不认为这是完全一样的,因为OP对答案进行了评论。

0 个答案:

没有答案