API documentation in Markdown


Keywords
documentation, API, docs, mkdocs, autodoc
License
BSD-3-Clause-Attribution
Install
pip install lucidoc==0.3

Documentation

lucidoc

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.