Már*_*cio 21 python documentation python-sphinx autodoc read-the-docs
我有一个模块,有两个记录的全球特殊成员.
在本地运行Sphinx会创建包含其文档的文档,但"阅读文档"却没有.它使用内置类型的文档.
我尝试了两种样式:#:和定义后的docstring.我已多次阅读autodoc的文档,并阅读了文档条目.我无法弄清楚我缺少什么,因为我甚至没有看到阅读文档中的任何构建错误.
有任何想法吗？
如果您使用 Napoleon 扩展来处理 NumPy 或 Google 风格的文档字符串，您可以在 conf.py 中为此设置一个配置标志
http://sphinx-doc.org/ext/napoleon.html?highlight=special#confval-napoleon_include_special_with_doc
如果我没记错的话，还有一个 autodoc 指令：
http://sphinx-doc.org/ext/autodoc.html?highlight=member#event-autodoc-skip-member
通过实现此方法，您可以细粒度地选择哪些成员将包含在文档中，哪些不包含在文档中。