Python:Sphinx:如何在Sphinx文档中自动包含所有类、方法和函数?

2024-06-06 15:31:05 发布

您现在位置:Python中文网/ 问答频道 /正文

Possible Duplicate:
Sphinx — combining automodule and autoclass

我尝试使用sphinx和它的autodoc插件为一个包含数千个类的项目创建一个html文档。sphinx apidoc创建了很棒的rst文件,但是缺少自动创建autocrassesautomethods的功能。

sphinx中是否有方法/命令/实用程序在文档中自动包含所有变量、函数、类和装饰符?

一个rst文件的一些示例代码:

tagger Package
=================

:mod:`tagger` Package
------------------------
.. automodule:: project.tagger
    :members:


:mod:`client` Module
--------------------
.. automodule:: project.analyzers.tagger.client
    :members:

Tags: 文件文档projectclientmodpackagesphinxrst