Automatically Generating Documentation for All Python Package Contents

后端 未结 4 2151
醉酒成梦
醉酒成梦 2020-12-04 09:03

I\'m trying to auto-generate basic documentation for my codebase using Sphinx. However, I\'m having difficulty instructing Sphinx to recursively scan my files.

I have

4条回答
  •  鱼传尺愫
    2020-12-04 10:04

    Perhaps apigen.py can help: https://github.com/nipy/nipy/tree/master/tools.

    This tool is described very briefly here: http://comments.gmane.org/gmane.comp.python.sphinx.devel/2912.

    Or better yet, use pdoc.


    Update: the sphinx-apidoc utility was added in Sphinx version 1.1.

提交回复
热议问题