让文档阅读包括特殊成员的autodoc文档吗?

问题描述 投票:21回答:1

我有一个包含两个有文档记录的全球特别会员的模块。

运行Sphinx在本地创建包含其文档的文档,但“阅读文档”则不包括。它改用内置类型的文档。

我尝试了两种样式:定义后的#:和docstring。我已经多次阅读autodoc的文档和Read the Docs entry on it。我无法弄清缺少的内容,因为我什至在Read the Docs上都看不到任何构建错误。

有什么想法吗?

我有一个模块,其中包含两个有文档记录的全球特别会员。在本地运行Sphinx会创建包含其文档的文档,但“阅读文档”则不会。它使用内置类型的文档...

python python-sphinx documentation-generation read-the-docs autodoc
1个回答
1
投票

如果您使用Napoleon扩展名来处理NumPy或Google样式的文档字符串,则可以在conf.py中为此设置配置标志

© www.soinside.com 2019 - 2024. All rights reserved.