Automatically Generating Documentation for All Python Package Contents

后端 未结 4 2143
醉酒成梦
醉酒成梦 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 09:50

    From Sphinx version 3.1 (June 2020), if you're happy to use sphinx.ext.autosummary to display summary tables, you can use the new :recursive: option to automatically detect every module in your package, however deeply nested, and automatically generate documentation for every attribute, class, function and exception in that module.

    See my answer here: https://stackoverflow.com/a/62613202/12014259

提交回复
热议问题