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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for pdoc-0.0.11.tar.gz
Algorithm Hash digest
SHA256 935e868b0d743052cdd5720d0d7ea84577ec5c4002b62be0b6de039a08aae809
MD5 b3c047455b637f0b9912c3a1037e055c
BLAKE2b-256 5b4960e3d0fa2ca6afa0858feb68e79b778c3d6e4ce052dfa4cb4b0eea457c84

See more details on using hashes here.

Supported by

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