sphinx的一个扩展,允许自动记录“variants”函数。
sphinx-autodoc-variants的Python项目详细描述
sphinx的一个扩展,允许自动记录variants函数。
概述
默认的sphinx.ext.autodoc模块不能正确处理由variants模块创建的变量的函数组。这个扩展注册了一个自动文档管理器,它可以检测不同的函数和方法,并支持主函数和不同函数的文档记录。
若要在使用variants的项目中使用此扩展,请首先使用pip安装此扩展(或者最好将其添加到文档依赖项中):
pip install sphinx_autodoc_variants
安装后,将'sphinx_autodoc_variants'添加到conf.py的extensions变量中,例如:
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx_autodoc_variants']
这将启用.. automodule或其他autodoc directives下variants函数的正确文档。
如果要显式地记录一个variants函数组,请对函数使用.. autoprimary_function,对方法使用.. autoprimary_method。