我有一个包含两个记录在案的全局特殊成员的模块。
在本地运行 Sphinx 会创建包含其文档的文档,但 Read the Docs 不会。它改为使用内置类型的文档。
我尝试了两种样式:#:
和定义后的文档字符串。我已多次阅读 autodoc
的文档,以及 Read the Docs entry on it .我无法弄清楚我错过了什么,因为我什至没有在 Read the Docs 上看到任何构建错误。
有什么想法吗?
最佳答案
如果您使用 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
通过实现此方法,您可以细粒度地选择哪些成员将包含在文档中,哪些不包含在文档中。
关于python - 使阅读文档包括特殊成员的 autodoc 文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/28004099/