- html - 出于某种原因,IE8 对我的 Sass 文件中继承的 html5 CSS 不友好?
- JMeter 在响应断言中使用 span 标签的问题
- html - 在 :hover and :active? 上具有不同效果的 CSS 动画
- html - 相对于居中的 html 内容固定的 CSS 重复背景?
我注意到 Sphinx 呈现类描述的行为发生了变化。给定这段代码
# my example happens to be a dataclass, but the behavior for
# regular classes is the same
@dataclass
class TestClass:
"""This is a test class for dataclasses.
This is the body of the docstring description.
"""
var_int: int
var_str: str
加上一些通用的 Sphinx 设置,大约两年前我曾经得到过这个
现在我明白了
有没有办法告诉 Sphinx 不要将类变量添加到类定义的底部?尤其令人讨厌的是,它假定它们的值为 None
,只是因为它们没有默认值。
这个问题是在关于 this post 的讨论中提出的,其中还包含更多有关 Sphinx 配置等注释的上下文。
最佳答案
对象的成员是否包含在 autodoc 指令中取决于:
:members:
选项(用于具有文档字符串的成员)。:undoc-members:
选项(对于没有文档字符串的成员)。例如:
dc module
=========
.. autoclass:: dc.Foo
在上面的 .rst
文件中,autodoc 指令没有显式设置选项,Sphinx 将隐式应用从 autodoc_default_flags
中获取的选项标志。在 conf.py
中。
在 conf.py
中设置以下内容将导致对象的所有成员(有或没有文档字符串)被 Sphinx 包含在所有未明确指定选项的指令中。
# autodoc settings
autodoc_default_options = {
'members': True,
'undoc-members': True,
}
结果:
但是,这提出了一个问题:如果成员在Attributes
中明确指定,autodoc 和 sphinx-napoleon 扩展会做什么 docstring section 但也包含在 autodoc 扩展中?
Docstrings
例如,将以下文档字符串与上面在 autodoc_default_options
中指定的选项一起使用。
import dataclasses
@dataclasses.dataclass
class Foo:
"""Docstring for Foo
Attributes:
var_a (str): An integer.
var_b (int): A string.
"""
var_a: str
var_b: int
在这种情况下,成员将被声明两次,每个扩展一次,相应的 reST 声明将作为副本生成。具有重复的 reST 声明将导致通常的警告:
C:\dc.py:docstring of dc.Foo.var_a:1: WARNING: duplicate object description of dc.Foo.var_a, other instance in dc, use :noindex: for one of them
C:\dc.py:docstring of dc.Foo.var_b:1: WARNING: duplicate object description of dc.Foo.var_b, other instance in dc, use :noindex: for one of them
这里有一个不同之处:sphinx-napoleon 将在自己的 docstring section 中声明成员而 autodoc 会像其他成员一样正常呈现它。视觉差异将取决于主题,例如使用 classic
主题:
最后,如果您想使用 sphinx-napoleon 记录成员 docstring sections并避免来自 autodoc 的重复 reST 声明,同时保持 autodoc_default_options
如图所示,您可以在该特定指令中显式使用 :exclude-members:
选项,例如:
dc module
=========
.. autoclass:: dc.Foo
:exclude-members: var_a, var_b
将仅使用 sphinx-napoleon 生成的 reST 指令记录成员:
关于python - napoleon 和 autodoc 如何交互记录成员,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/64588821/
我正在处理一组标记为 160 个组的 173k 点。我想通过合并最接近的(到 9 或 10 个组)来减少组/集群的数量。我搜索过 sklearn 或类似的库,但没有成功。 我猜它只是通过 knn 聚类
我有一个扁平数字列表,这些数字逻辑上以 3 为一组,其中每个三元组是 (number, __ignored, flag[0 or 1]),例如: [7,56,1, 8,0,0, 2,0,0, 6,1,
我正在使用 pipenv 来管理我的包。我想编写一个 python 脚本来调用另一个使用不同虚拟环境(VE)的 python 脚本。 如何运行使用 VE1 的 python 脚本 1 并调用另一个 p
假设我有一个文件 script.py 位于 path = "foo/bar/script.py"。我正在寻找一种在 Python 中通过函数 execute_script() 从我的主要 Python
这听起来像是谜语或笑话,但实际上我还没有找到这个问题的答案。 问题到底是什么? 我想运行 2 个脚本。在第一个脚本中,我调用另一个脚本,但我希望它们继续并行,而不是在两个单独的线程中。主要是我不希望第
我有一个带有 python 2.5.5 的软件。我想发送一个命令,该命令将在 python 2.7.5 中启动一个脚本,然后继续执行该脚本。 我试过用 #!python2.7.5 和http://re
我在 python 命令行(使用 python 2.7)中,并尝试运行 Python 脚本。我的操作系统是 Windows 7。我已将我的目录设置为包含我所有脚本的文件夹,使用: os.chdir("
剧透:部分解决(见最后)。 以下是使用 Python 嵌入的代码示例: #include int main(int argc, char** argv) { Py_SetPythonHome
假设我有以下列表,对应于及时的股票价格: prices = [1, 3, 7, 10, 9, 8, 5, 3, 6, 8, 12, 9, 6, 10, 13, 8, 4, 11] 我想确定以下总体上最
所以我试图在选择某个单选按钮时更改此框架的背景。 我的框架位于一个类中,并且单选按钮的功能位于该类之外。 (这样我就可以在所有其他框架上调用它们。) 问题是每当我选择单选按钮时都会出现以下错误: co
我正在尝试将字符串与 python 中的正则表达式进行比较,如下所示, #!/usr/bin/env python3 import re str1 = "Expecting property name
考虑以下原型(prototype) Boost.Python 模块,该模块从单独的 C++ 头文件中引入类“D”。 /* file: a/b.cpp */ BOOST_PYTHON_MODULE(c)
如何编写一个程序来“识别函数调用的行号?” python 检查模块提供了定位行号的选项,但是, def di(): return inspect.currentframe().f_back.f_l
我已经使用 macports 安装了 Python 2.7,并且由于我的 $PATH 变量,这就是我输入 $ python 时得到的变量。然而,virtualenv 默认使用 Python 2.6,除
我只想问如何加快 python 上的 re.search 速度。 我有一个很长的字符串行,长度为 176861(即带有一些符号的字母数字字符),我使用此函数测试了该行以进行研究: def getExe
list1= [u'%app%%General%%Council%', u'%people%', u'%people%%Regional%%Council%%Mandate%', u'%ppp%%Ge
这个问题在这里已经有了答案: Is it Pythonic to use list comprehensions for just side effects? (7 个答案) 关闭 4 个月前。 告
我想用 Python 将两个列表组合成一个列表,方法如下: a = [1,1,1,2,2,2,3,3,3,3] b= ["Sun", "is", "bright", "June","and" ,"Ju
我正在运行带有最新 Boost 发行版 (1.55.0) 的 Mac OS X 10.8.4 (Darwin 12.4.0)。我正在按照说明 here构建包含在我的发行版中的教程 Boost-Pyth
学习 Python,我正在尝试制作一个没有任何第 3 方库的网络抓取工具,这样过程对我来说并没有简化,而且我知道我在做什么。我浏览了一些在线资源,但所有这些都让我对某些事情感到困惑。 html 看起来
我是一名优秀的程序员,十分优秀!