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.8

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for pdoc-0.0.8.tar.gz
Algorithm Hash digest
SHA256 23a099640abd748b24c6914838e9cb1d8421b7e24c8055c2bd29a2edf2a31004
MD5 1f142fabf87d5691b584a30027398cd2
BLAKE2b-256 7067686f4d3a9fa2467e476c2509cf95e0f1f0b00772876337cbc7b9c9dbfc27

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