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.5b2.tar.gz (83.0 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for pydoctor-0.5b2.tar.gz
Algorithm Hash digest
SHA256 abaadc7857114e61a0cc7d76a4ba55bb5b89cfceac4bd835867a638f6efac55d
MD5 7beaa325a9250975403c4ec9606d295a
BLAKE2b-256 a1eae411968aca9a026df147ec01c4cfbae0c8359e8d3e5d5c6aa31423ad9788

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