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

This version

0.0.6

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for pdoc-0.0.6.tar.gz
Algorithm Hash digest
SHA256 156c1ee3db31c2ce7a8d4383a73fb2b8cb9d4b6989b53b5f65a7f35ab181da65
MD5 aeff421f90bd3f2c7be08054e674386e
BLAKE2b-256 d9d289de427c095398a07c6e5fcff8d6e5242e57490c0115c94690f0b485865e

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