Sphinx扩展,自动记录单击应用程序

sphinx-click的Python项目详细描述


CI StatusDocumentation Status

sphinx click是一个Sphinx插件,允许您自动提取 来自click-based应用程序的文档,并将其包含在文档中。

安装

使用pip安装插件

$ pip install sphinx-click

或者,通过克隆此repo然后运行 setup.py

$ python setup.py install

用法

重要

要记录基于单击的应用程序,包括应用程序本身和任何 必须安装该应用程序所需的附加依赖项

在sphinxconf.py文件中启用插件:

extensions=['sphinx_click.ext']

一旦启用,您现在可以在 文档。

.. click:: module:parser
   :prog: hello-world
   :show-nested:

有关各种可用选项的详细信息,请参见 documentation

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

推荐PyPI第三方库


热门话题
java Clojure关键字在内存中的大小是多少?   Java中有固定长度的通用数组对象吗?   PostgreSQL:通过Java更新我的用户表   错误:使用java解析xml   java Json显示列表中对象的名称   java比较JodaTime时区   与JAVA中的API和包的区别?   java的int值在for循环中不改变   谷歌应用引擎中的java RSA   迁移到spring 5后出现java非法字符错误   java Websphere管理控制台不工作   JavaGSON如何始终在json中包含毫秒?   带有空格和双引号的windows Java ProcessBuilder命令参数失败   java错误:重复的zip条目[43.jar:org/apache/http/annotation/NotThreadSafe.class]