jjzjj

python - 狮身人面像 : force rebuild of html, 包括 autodoc

目前,每当我运行sphinx-build时,只有当源文件发生变化时,才会选取和使用内联文档字符串。我试过使用-a开关调用sphinx-build但这似乎没有效果。如何强制完全重建HTML输出并强制执行autodoc? 最佳答案 如果-Eoption似乎有效与-a一起使用。我将它添加到我的Makefile中的html目标中,现在可以在不更新任何.rst文件的情况下获取文档字符串中的更改。 关于python-狮身人面像:forcerebuildofhtml,包括autodoc,我们在Stac

python - 使阅读文档包括特殊成员的 autodoc 文档?

我有一个包含两个记录在案的全局特殊成员的模块。在本地运行Sphinx会创建包含其文档的文档,但ReadtheDocs不会。它改为使用内置类型的文档。我尝试了两种样式:#:和定义后的文档字符串。我已多次阅读autodoc的文档,以及ReadtheDocsentryonit.我无法弄清楚我错过了什么,因为我什至没有在ReadtheDocs上看到任何构建错误。有什么想法吗? 最佳答案 如果您使用Napoleon扩展来处理NumPy或Google样式的文档字符串,您可以在conf.py中为此设置一个配置标志http://sphinx-doc

Python Sphinx autodoc 和装饰成员

我正在尝试使用Sphinx来记录我的Python类。我使用自动文档这样做:..autoclass::Bus:members:虽然它正确地为我的方法获取文档字符串,但那些被修饰的方法:@checkStaledefopen(self):"""Somedocs."""#Code@checkStale存在defcheckStale(f):@wraps(f)defnewf(self,*args,**kwargs):ifself._stale:raiseExceptionreturnf(self,*args,**kwargs)returnnewf有一个不正确的原型(prototype),例如ope

python - 如何使用 Sphinx 的 autodoc 来记录类的 __init__(self) 方法?

默认情况下,Sphinx不会为__init__(self)生成文档。我尝试了以下方法:..automodule::mymodule:members:和..autoclass::MyClass:members:在conf.py中,设置以下内容仅将__init__(self)文档字符串附加到类文档字符串(theSphinxautodocdocumentation似乎同意这是预期的行为,但没有提及我要解决的问题):autoclass_content='both' 最佳答案 这里有三种选择:为确保始终记录__init__(),您可以使用au