Skip to main content

A simple program to auto generate API documentation for Python libraries.

Project description

A simple program (and library) to auto generate API documentation for Python libraries. All documentation text is parsed as Markdown and can be outputted as HTML or as plain text for console use. There are no special syntax rules, just pure Markdown.

While pdoc tries to stay consistent with documentation practices recommend by PEP 8 and PEP 257, pdoc also looks for documentation of representation in some places just as epydoc does. Namely, docstrings proceeding module level variables, class variables and instance variables in __init__ methods. This is done by traversing the ast of the source text.

Project details


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

pdoc-0.0.10.tar.gz (32.9 kB view details)

Uploaded Source

File details

Details for the file pdoc-0.0.10.tar.gz.

File metadata

  • Download URL: pdoc-0.0.10.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pdoc-0.0.10.tar.gz
Algorithm Hash digest
SHA256 574a385dcef9992210e966b7d687d2d747124848a1ece377352a219908921a08
MD5 40bbe89674212003e098b8dbd031b3f0
BLAKE2b-256 af788b5b45889cc54c8326fe56f4c8b27faf5f1d8fdd43ca26c8d0a5b82a33c1

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