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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for pdoc-0.0.12.tar.gz
Algorithm Hash digest
SHA256 de4c065f1444581e52bafddc9619567dca6124f42699e8be8f059752bf51af6b
MD5 ec03f8f196319b17cf6558c53e7af20e
BLAKE2b-256 dba721bf7b0a212f24269fa4fdfd3476a94b536c87883ab76b27cb1643fdc17c

See more details on using hashes here.

Supported by

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