Automatic Python module documentation with Sphinx: add a table of content

人盡茶涼 提交于 2019-12-24 21:26:29

问题


I am using the automodule directive to document some Python module using Sphinx:

.. automodule:: mymodule.mysubmodule
    :members:

This works very well.

However, I would like to include a sort of "table of content" of all the members to be documented this way. For example if mysubmodule contains classes A, B and C I would these displayed as a list above the details (with links).

来源:https://stackoverflow.com/questions/53371146/automatic-python-module-documentation-with-sphinx-add-a-table-of-content

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!