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调用为:
----
:目标: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
等待测试通过。
在本地分支上创建一个标记,然后将其推送: