Skip to main content

API documentation in Markdown

Project description


Build Status Coverage Status

Lucidoc is a Python package that makes it easier to automatically document Python packages. It is specifically useful for documenting Python packages using mkdocs.

It parses Python docstrings and uses them to autogenerate a package API documentation page in markdown format. Since lucidoc outputs markdown format, it's convenient to link with mkdocs for building automatic documentation web pages.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lucidoc-0.4.4.tar.gz (15.1 kB view hashes)

Uploaded Source

Built Distribution

lucidoc-0.4.4-py3-none-any.whl (16.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page