API doc generator.
Project description
This is pydoctor, an API documentation generator that works by static analysis.
It was written primarily to replace epydoc for the purposes of the Twisted project as epydoc has difficulties with zope.interface. If you are looking for a successor to epydoc after moving to Python 3, pydoctor might be the right tool for your project as well.
pydoctor puts a fair bit of effort into resolving imports and computing inheritance hierarchies and, as it aims at documenting Twisted, knows about zope.interface’s declaration API and can present information about which classes implement which interface, and vice versa.
Usage
You can run pydoctor on your project like this:
$ pydoctor --make-html --html-output=docs/api --add-package=src/mylib
You can see the full list of options using pydoctor --help.
Markup
pydoctor currently supports the following markup languages in docstrings:
- epytext (default)
The markup language of epydoc. Simple and compact.
- reStructuredText
The markup language used by Sphinx. More expressive than epytext, but also slighly more complex and verbose.
- plain text
Text without any markup.
You can select a different format using the --docformat option.
Sphinx Integration
Sphinx object inventories can be used to create deep links between API documentation generated by pydoctor and by Sphinx.
Linking to external API docs
It can link to external API documentation using a Sphinx objects inventory with the following cumulative configuration option:
--intersphinx=http://sphinx-doc.org/objects.inv
Linking to your API docs
pydoctor’s HTML generator will also generate a Sphinx objects inventory using the following mapping:
packages, modules -> py:mod:
classes -> py:class:
functions -> py:func:
methods -> py:meth:
attributes -> py:attr:
To use this mapping in Sphinx, configure the intersphinx extension:
intersphinx_mapping = {
'pydoctor': ('http://domain.tld/api', None),
}
And use external references:
: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`
What’s New?
pydoctor 20.7.0
Python 3 support
Type annotations on attributes are supported when running on Python 3
Type comments on attributes are supported when running on Python 3.8+
Type annotations on function definitions are not supported yet
Undocumented attributes are now included in the output
Attribute docstrings: a module, class or instance variable can be documented by a following it up with a docstring
Improved error reporting: more errors are reported, error messages include file name and line number
Dropped support for implicit relative imports
Explicit relative imports (using from) no longer cause warnings
Dropped support for index terms in epytext (X{}); this was never supported in any meaningful capacity, but now the tag is gone
This will be the last release to support Python 2.7 and 3.5: future releases will require Python 3.6 or later.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file pydoctor-20.7.0.tar.gz.
File metadata
- Download URL: pydoctor-20.7.0.tar.gz
- Upload date:
- Size: 111.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/2.7.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ca2082c60da80348a67c83790a1619988ea7f17855c00770cfe99828cfc6994f |
|
| MD5 | aafbc6ac6547b6ef8f53d97135d07f34 |
|
| BLAKE2b-256 | 29fc362e9c5592bbb32b075e9c4868c886b653fe7c0176eedc8b3edd16e84ae1 |
