sphinx-autodoc-defaultargs
概述
该扩展自动为Sphinx autodoc扩展生成默认参数。
例子
使用此程序包,将自动检测所有记录的参数和未记录的参数(如果启用)的默认值,并将其添加到文档字符串中。
它还会检测默认参数的现有文档,且文本不变。
def func ( x = None , y = None ):
"""
Example docstring.
:param x: The default value ``None`` will b
AutoDoc的服务器扩展
安装套件
使用上述包装,一旦将包装发布在pypi.org上,便可以通过一个命令来安装扩展:
# Install the server extension and
# copy the frontend extension where JupyterLab can find it
pip install jlab_ext_example
作为开发人员,您可能想以本地可编辑模式安装软件包。 这将分流上述安装机械。 因此,设置命令如下:
# Install packa