自动生成类似numpy的文档

时间:2019-11-17 17:23:19

标签: python python-sphinx

我正在尝试生成最简单的numpy样式的文档。 我有一个使用numpy文档字符串的模块,并且希望每个sumbodule和每个函数都在其自己的页面上,因为文档字符串会变得很长。假设我们具有以下结构:

module/__init__.py
module/a/__init__.py
module/a/aa.py
module/a/ab.py
module/b.py

我的索引文件是

# index.rst

.. autosummary::
   :toctree: _autosummary

然后在所有__init__.py文档字符串中放置一个子模块部分

""" # module/__init__.py
Submodules
----------

.. autosummary::
    :toctree:  _autosummary

    a
    b

"""

会生成一个目录,但是所有功能都显示在同一页面上。 我尝试创建_templates/autosummary/module.rst来更改此行为,但未成功。

文档和教程似乎都无济于事。我尝试过:

https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html
https://romanvm.pythonanywhere.com/post/autodocumenting-your-python-code-sphinx-part-ii-6/
https://wwoods.github.io/2016/06/09/easy-sphinx-documentation-without-the-boilerplate/

,但没有任何帮助。从文档字符串自动获取类似numpy的文档的最简单方法是什么?

问题Using Sphinx to automatically generate a separate document for each function 建议用手编写所有内容。但是我敢肯定,这样一来,我会忘记包含功能...

0 个答案:

没有答案