Skip to main content

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 it happens to work for your code too, that’s a nice bonus :)

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.

The default HTML generator requires Twisted.

There are some more notes in the doc/ subdirectory.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydoctor-0.5.tar.gz (83.6 kB view details)

Uploaded Source

File details

Details for the file pydoctor-0.5.tar.gz.

File metadata

  • Download URL: pydoctor-0.5.tar.gz
  • Upload date:
  • Size: 83.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pydoctor-0.5.tar.gz
Algorithm Hash digest
SHA256 f55d7e7847274974a3f37ac06d41215ed29ebbe5b0cf075ee17148763e8d2f12
MD5 76652703e59f8ee4e767f33d3510ba81
BLAKE2b-256 2107ae514d9496be0f68e38c94deff75bafb281e33e140de3c635768d8627056

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page