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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for pdoc-0.0.14.tar.gz
Algorithm Hash digest
SHA256 c51a8923259636f2e602dfd25f35d127c08d50ebb1a3af04f66acaf22eb85a0f
MD5 38a8d4b58f004c7a820757ded40ed967
BLAKE2b-256 2ea15700978e21db282ea3e2402583a38c92b38bded814a9a0257730e3a3f503

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