databio / lucidoc

Automatic python documentation in markdown for mkdocs

Home Page:https://pypi.org/project/lucidoc/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

About

Automatic python documentation in markdown for mkdocs

https://pypi.org/project/lucidoc/


Languages

Language:Python 100.0%