API文档生成器。

pydoctor的Python项目详细描述


皮多克图片::https://travis-ci.org/twisted/pydoctor.svg?branch=tox-travis-2
:目标:https://travis ci.org/twisted/pydoctor

…image::https://codecov.io/gh/twisted/pydoctor/branch/master/graph/badge.svg
:target:https://codecov.io/gh/twisted/pydoctor


这是一个api文档生成器,通过
静态分析工作。

带着zope.interface。如果它碰巧也适用于您的代码,那么这是一个很好的好处:)


pydoctor在解析导入和计算继承层次结构方面付出了相当大的努力,并且,由于它的目的是记录
twisted,它知道zope.interface的声明api,并且可以提供关于哪个类实现哪个接口的
信息,以及反之亦然。


默认的html生成器需要twisted。


在doc/子目录中还有一些注释。



=-


由于还不支持python 3,因此默认的
tox运行在python 3中,将tox调用为:



----



*包、模块->;py:mod:
*类->;py:class:
*函数->;py:func:
*方法->;py:meth:
*attributes->;py:attr:

>配置sphinx intersphinx扩展:

>intersphinx-u映射={
'pydoctor':('http://domain.tld/api',none),
}


使用外部引用::

:py:func:`external api<;pydoctor:pydoctor.model.documentable.reparent>;`

:py:mod:`pydoctor:pydoctor`
:py:mod:`pydoctor:pydoctor.model`
:py:func:`pydoctor:pydoctor.driver.getparser`
:py:class:`pydoctor:pydoctor.model.documentable`
:py:meth:`pydoctor:pydoctor.model.documentable.reparent`
:py:attr:`pydoctor:pydoctor.model.documentable.kind`

使用Sphinx对象清单的外部API文档使用以下累积配置选项:

--intersphinx=http://sphinx doc.org/objects.inv



等待测试通过。
在本地分支上创建一个标记,然后将其推送:

git push--tags

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

推荐PyPI第三方库


热门话题
为@Nonnull注释参数编写java单元测试   对于JAVA,如何从它自己的类调用插入排序来将数组分类到一个单独的类中?   Java中嵌套SQL查询的字符串解析   java在所有带有特定注释的方法上调用带注释的方面   在Java中将base64转换为PDF   无法在Android上强制转换java getApplicationContext()   雅加达ee Java ee:如何获取我的应用程序的URL?   IntelliJ:如何导入的文件夹。java文件作为库?   多线程Java(FX)在播放一种声音的同时,播放另一种声音   网络爬虫我需要将proto3版本中protobuf生成的java代码添加到nutch 1.7中   使用JAXRS注释资源的java Restlet客户端   java如何查找给定月份的日期范围   java Minecraft Bukkit插件:我的小游戏传送机不工作   Java Excel搜索和数组列表工作不正常