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 at this stage :)

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 uses Nevow, which means that it requires Twisted too.

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.4.tar.gz (81.1 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for pydoctor-0.4.tar.gz
Algorithm Hash digest
SHA256 7c7ca5f7a5daa7999065752f1293b8b1f319fded3750d0c01da30060f1638b69
MD5 b7564e12b5d35d4cb529a2c220b25d3a
BLAKE2b-256 1a66596a6fe6f862b604a42fe3b0f3366078d5c88d37cc9b1da8fdfa322c1172

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