sphinx的一个扩展,允许自动记录“variants”函数。

sphinx-autodoc-variants的Python项目详细描述


https://travis-ci.org/python-variants/sphinx_autodoc_variants.svg?branch=master

sphinx的一个扩展,允许自动记录variants函数。

概述

默认的sphinx.ext.autodoc模块不能正确处理由variants模块创建的变量的函数组。这个扩展注册了一个自动文档管理器,它可以检测不同的函数和方法,并支持主函数和不同函数的文档记录。

若要在使用variants的项目中使用此扩展,请首先使用pip安装此扩展(或者最好将其添加到文档依赖项中):

pip install sphinx_autodoc_variants

安装后,将'sphinx_autodoc_variants'添加到conf.pyextensions变量中,例如:

extensions = ['sphinx.ext.autodoc',
              'sphinx.ext.viewcode',
              'sphinx_autodoc_variants']

这将启用.. automodule或其他autodoc directivesvariants函数的正确文档。

如果要显式地记录一个variants函数组,请对函数使用.. autoprimary_function,对方法使用.. autoprimary_method

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java语义理解递归反向字符串返回语句   java toString()方法打印空值   java大型IN子句   如何使用JavaSpring在JavaScriptjQuery中设置post路径   java ByteArrayOutputStream已上载到服务器   java为什么轮询在SocketIO上获取数据“无法加载请求的项”?   java源代码应该以UTF8格式保存   Java数据库轮询器?   在Java中将double转换为float   java AccessDeniedException:C:\Windows\System32\drivers\etc\hosts