在Sphinx

时间:2017-11-15 08:29:07

标签: python python-sphinx autodoc

我正在使用Sphinx的autodoc模块进行Python文档编制。我希望我的继承类显示其成员函数及其文档字符串的详细信息。所以我设置了以下选项:

export SPHINX_APIDOC_OPTIONS=members,undoc-members,show-inheritance,inherited-members

虽然这样做会成功编辑带有所需标签的第一个文件,但它无法完成工作。我的html页面显示了继承类文档的超链接。我想要详细阐述。

我还在conf.py中使用autodoc_default_flags,但似乎无法正常工作:

autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance', 'inherited-members']

我做得对吗? SPHINX_APIDOC_OPTIONS的顺序是否重要,我是否给出了正确的顺序?此外,sphinx-apidocsphinx-build命令下是否有选项可以执行相同的操作?

0 个答案:

没有答案