sphinx autodoc控制成员是否被记录的简单工具。

docit的Python项目详细描述


=================================================================
记录
=================================================================

…#职务
…#开始徽章

PYPI版本徽章许可证徽章PYPI下载徽章|

…| Pypi版本徽章图像::http://img.shields.io/Pypi/v/docit.svg
:alt:[pypi上的最新版本]
:目标:https://pypi.python.org/pypi/docit

…| Pypi下载徽章图像::http://img.shields.io/Pypi/dm/docit.svg
:alt:[在pypi上下载]
:目标:https://pypi.python.org/pypi/docit

…|许可证徽章图像::http://img.shields.io/badge/license-gplv3+-brightgreen.svg
:高度:[gplv3+]
:目标:https://www.gnu.org/licenses/gpl.html


…#末端徽章


**docit**是一个python包,它提供了一些简单的工具,可用于sphinx
autodoc控制文档中是否包含成员。


…目录::**页面内容**
:本地:
:深度:2
:反向链接:顶部

tl;博士
------

什么?
~~~~~~~~~~~~~~

sphinx<;http://sphinx doc.org/>;``为个人控制autodoc的扩展
成员。

安装?
~~~~~~~~~~~~~

…代码::bash

$pip安装文档

或,来源:

…代码::bash

$python setup.py安装


示例?
~~~~~~~~~~~~~~~~~~

…待办事项:
示例代码

…代码::python

>>gt;导入文档
>;>;

依赖关系?
~~~~~~~~~~~~~~~~

docit是针对“python<;https://www.python.org/>;”版本2.7开发的。

要从源代码(按原样)构建sphinx文档,您需要“sphinx-rtd”主题:

…代码::bash

$pip安装sphinx_rtd_主题


文档?
~~~~~~~~

*`阅读文档(.org)<;http://docit.read the docs.org/>;。`_
*`python托管(.org)<;http://python hosted.org/docit/>;。`_


其他
------


联系方式
~~~~~~~~~~~~~~~~~~~~~~~~

此项目当前托管在“bitbucket”<;https://bitbucket.org>;`,
请访问“https://bitbucket.org/bmearns/docit<;https://bitbucket.org/bmearns/docit/>;”。
主要作者是brian mearns,您可以通过Bitbucket在
`https://bitbucket.org/bmearns<;https://bitbucket.org/bmearns>;`。


版权和许可
~~~~~~~~~~~~~~~~~~~~~~~~~~

``docit``是一个免费软件*:您可以重新分发和/或修改它
根据
自由软件基金会,许可证的第3版,或
(由您选择)任何更高版本。



``docit``是为了让它有用而发布的,
但是没有任何担保;甚至没有
.*适销性.*或.*适合特定用途.*见
GNU通用公共许可证了解更多详细信息。



GNU通用公共许可证的副本可在
\``docit``文件license.txt下的分发。如果你没有
接收此文件的副本,请参见
`http://www.gnu.org/licenses/<;http://www.gnu.org/licenses/>;`。

…_ Sphinx_RTD_主题:https://github.com/snide/sphinx_RTD_主题

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

推荐PyPI第三方库


热门话题
java如何使用JDOM设置布尔字段   java准备语句和语句/查询缓存   java Jpanel与JFrame菜单栏重叠   java比较两个JodaTime DateTime对象   java为什么Android Room@Query LIKE不返回已知存在的数据   使用Java和COM4J的Quality Center V11脚本统计   java获取当前登录用户的详细信息   如果页面上存在元素,如何在控制台中显示   java在GUI不更新信息时使用SWING和多线程处理GUI   java LOG4J2 RollingFile Appender未写入文件   java“new TextToSpeech.OnInitListener()”的颜色不鲜艳,这表明它没有被使用,如何使其可用?   java在paint方法中绘制形状   JAVA木卫一。文件旅游目的地?   java Struts2 dojo锚定标记不起作用?   java JavaFX ObservalElist和提取器更新事件在应该时未触发