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 xtext项目中的默认内容辅助功能在哪里   通过相似(不相同)键的java分组映射   java Dagger 2 reinit singleton   检测图像中的矩形会产生不想要的结果(opencv,java)   Java方法调用与使用变量的性能比较   尝试使用hibernate连接到mysql时,java连接被拒绝   允许端口的java IP地址正则表达式   通过Socket实现java Android到PC的数据交换   java使用maven向类路径添加额外的配置文件夹   java我似乎无法从RMI存根获得socket工厂。为什么会这样?   java使用hibernate向数据库添加数据   java驱动程序对于Chromedriver不可执行   java编译错误。mysql。jdbc。驱动程序无法解析为变量