Python sphinx 带自动模块的斯芬克斯树
我有一些我想记录的模块,目录在主页Python sphinx 带自动模块的斯芬克斯树,python-sphinx,autodoc,toctree,Python Sphinx,Autodoc,Toctree,我有一些我想记录的模块,目录在主页索引中,文档本身在单独的页面中。我不熟悉自动文档和Sphinx,但我已经接近: index.rst: Documentation ************* .. toctree:: :maxdepth: 2 Module1 Module2 Index ===== * :ref:`genindex` * :ref:`modindex` Module1.rst and Module2.rst: Title ***** .. auto
索引中,文档本身在单独的页面中。我不熟悉自动文档和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
的原因是获得重复的对象描述错误。但是,这会阻止模块显示在索引的目录树上。如何避免这种情况?这似乎是一件很基本的事情,但我无法理解。。任何帮助都将不胜感激
它似乎和它的答案试图解决一个类似的问题,但我认为它与OP对答案的评论不太一样。我建议您看看,它有叙述、API和脚本的自动文档。另外,还可以查看和,这是一个自动记录模块的过程。