sphinx-autodoc-defaultargs:自动生成Sphinx autodoc扩展的默认参数

时间:2024-04-20 17:03:17
【文件属性】:

文件名称:sphinx-autodoc-defaultargs:自动生成Sphinx autodoc扩展的默认参数

文件大小:16KB

文件格式:ZIP

更新时间:2024-04-20 17:03:17

Python

sphinx-autodoc-defaultargs 概述 该扩展自动为Sphinx autodoc扩展生成默认参数。 例子 使用此程序包,将自动检测所有记录的参数和未记录的参数(如果启用)的默认值,并将其添加到文档字符串中。 它还会检测默认参数的现有文档,且文本不变。 def func ( x = None , y = None ): """ Example docstring. :param x: The default value ``None`` will be added here. :param y: The text of default value is unchanged. (Default: ``'Default Value'``) """ if y is None : y


【文件预览】:
sphinx-autodoc-defaultargs-main
----pyproject.toml(342B)
----.github()
--------workflows()
----tests()
--------roots()
--------conftest.py(2KB)
--------test_sphinx_autodoc_defaultargs.py(7KB)
----tox.ini(551B)
----sphinx_autodoc_defaultargs.py(17KB)
----LICENSE(1KB)
----setup.cfg(1KB)
----setup.py(239B)
----.gitignore(76B)
----README.md(3KB)

网友评论