Sphinx:我如何记录模块的所有类/成员,而不是模块本身

时间:2015-03-11 18:40:53

标签: python-sphinx

我想在模块中编写一些文档,这些文档应该是我文档的一个部分。此时我不想记录模块的所有类/成员。这可以通过

轻松完成
..automodule:: myModule
  :no-members:

但是,在我的文档的另一点上,我想记录myModule的所有类。我可以用

做到这一点
..automodule:: myModle
  :members:
  :noindex:

不幸的是,这还包括我在文档中已经拥有的模块本身的文档,而且我不想再次访问这些文档。

有没有办法只显示myModule的所有成员的文档,而不是myModule本身的文档而不必手动列出所有成员?

1 个答案:

答案 0 :(得分:1)

感谢我的评论,我能够解决问题。将以下行添加到conf.py可以解决问题:

def remove_module_docstring(app, what, name, obj, options, lines):
    if what == "module" and name == "hpclogging.logger" and 'members' in options:
        del lines[:]

def setup(app):
    app.connect("autodoc-process-docstring", remove_module_docstring)