Using Sphinx to automatically generate a separate document for each function

前端 未结 2 1278
南笙
南笙 2020-12-03 19:06

I\'ve been building a Python module with many different functions.

I\'m using Sphinx and readthedocs to provide documentation. I\'ve made decent progress, but curre

2条回答
  •  执笔经年
    2020-12-03 19:21

    I think the sphinx-automodapi Sphinx extension may do what you need. Essentially to document a module you would just do:

    .. automodapi:: mypackage.mymodule
    

    and it will generate the table and individual pages for each function.

    Disclaimer: I am an author of sphinx-automodapi

提交回复
热议问题