Make Read the Docs包括特殊成员的autodoc文档？

Question

我有一个模块，其中包含两个记录在案的全球特殊成员。

在本地运行Sphinx会创建包含其文档的文档，但“阅读文档”却没有。它使用内置类型的文档。

我在定义后尝试了两种样式：#:和docstring。我已多次阅读autodoc的文档和Read the Docs entry on it。我无法弄清楚我错过了什么，因为我甚至没有在阅读文档时看到任何构建错误。

有什么想法吗？

Answer 1

如果您使用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

通过实施此方法，您可以精确选择哪个成员将包含在文档中，哪个不包含在文档中。