我想在我的 Sphinx 文档中只包含特定函数的文档字符串。但是,似乎没有选项可以使用http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html在没有关联的类和函数定义的情况下仅显示这些详细信息
我已经尝试创建一个类,如Show *only* docstring in Sphinx 文档中所述?但我不确定这如何适合模板。
我也尝试过 autodoc-process-docstring 事件处理程序,但没有成功。
因此,而不是我的文档显示(目前):
class module.MyClass(param)
This is the class doc string
my_method()
This is my method doc string
我只想显示:
This is my method doc string
我当前在 .txt 文件中的模板是:
.. autoclass:: module.MyClass
:members: my_method