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

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for pdoc-0.0.2.tar.gz
Algorithm Hash digest
SHA256 3c4af14bbd3a67b76fe94eda7d2a5226c4cd8cb4b43add1049056a19b430b205
MD5 8359918432614d74308a60c4c603a9d5
BLAKE2b-256 78420477b6ab1717f546a51a38618b0a3d5e6b917e406d5e03aca9ffa0ce0dfa

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