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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for pdoc-0.0.9.tar.gz
Algorithm Hash digest
SHA256 1462e251e044307488ac17ba43e48284ce23a17d73605e49585967bfb35f2abb
MD5 f8ac6a6215eeb4d14de0499d420d9148
BLAKE2b-256 861f5a38d57c07a10fa98a2951c8ddce270ad9eb50f8455ec24fc97810ee04ba

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