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

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for pdoc-0.0.1.tar.gz
Algorithm Hash digest
SHA256 c468ffd5375470e3a5602c5c6a252cbb163fcc05fdb5bdc0cad0dd23d58ed902
MD5 67288e9c7a0c8c5c5fbc02f7791a1337
BLAKE2b-256 ee1a52a61f3a15f1bf79b9f094192e0eeb4e8c56636c14e8fb19f82622b62a40

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