Python sphinx Sphinx自定义自动类输出
我有一个有几个类的模块。目前我正在使用Python sphinx Sphinx自定义自动类输出,python-sphinx,Python Sphinx,我有一个有几个类的模块。目前我正在使用.automodule来记录模块。我希望每个类都有自己的标题部分和类名。我可以通过将.automodule foo替换为: Bar === ..autoclass foo.Bar Baz === ..autoclass foo.Baz ... 然而,这需要我手动列出每个模块中的每个类。自定义automodule生成的内容的最佳方法是什么?Sphinx不像Epydoc或Doxygen那样直接用于从源代码生成API文档。这是一种不同的工具 Sphinx
.automodule
来记录模块。我希望每个类都有自己的标题部分和类名。我可以通过将.automodule foo
替换为:
Bar
===
..autoclass foo.Bar
Baz
===
..autoclass foo.Baz
...
然而,这需要我手动列出每个模块中的每个类。自定义automodule生成的内容的最佳方法是什么?Sphinx不像Epydoc或Doxygen那样直接用于从源代码生成API文档。这是一种不同的工具 Sphinx处理.rst(StructuredText)文件,如果希望每个类都有自己的标题和类名,则必须自己添加标题并使用
。。自动类::
。仅使用无法完成此操作。。自动模块::
。是的,这很不方便(表达了类似的观点)。另见和
这个问题可以通过遍历Python代码并生成.rst输出的脚本来缓解。斯芬克斯已经有了这样的剧本。但是,它不会生成任何。。自动类::
指令,仅限。。自动模块::
下面是另一个可以输出的脚本。。自动类::
:。也许你可以用这个