https://github.com/databio/lucidoc

Automatic python documentation in markdown for mkdocs
https://github.com/databio/lucidoc

Last synced: 5 months ago
JSON representation

Automatic python documentation in markdown for mkdocs

• Host: GitHub
• URL: https://github.com/databio/lucidoc
• Owner: databio
• Created: 2019-02-12T22:07:21.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-18T20:10:03.000Z (over 2 years ago)
• Last Synced: 2025-07-05T22:02:22.272Z (12 months ago)
• Language: Python
• Homepage: https://pypi.org/project/lucidoc/
• Size: 170 KB
• Stars: 1
• Watchers: 8
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • Support: docs/support.md

Awesome Lists containing this project

README

          
# lucidoc

[![Build Status](https://travis-ci.org/vreuter/lucidoc.svg?branch=master)](https://travis-ci.org/vreuter/lucidoc)

[![Coverage Status](https://coveralls.io/repos/github/vreuter/lucidoc/badge.svg?branch=master)](https://coveralls.io/github/vreuter/lucidoc?branch=master)

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.