API documentation in Markdown
Project description
lucidoc
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
Release history Release notifications | RSS feed
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 details)
Built Distribution
lucidoc-0.4.4-py3-none-any.whl
(16.3 kB
view details)
File details
Details for the file lucidoc-0.4.4.tar.gz
.
File metadata
- Download URL: lucidoc-0.4.4.tar.gz
- Upload date:
- Size: 15.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e4ba666672b9f59117ae251c4f2ec674a2d5258a3fd97d4173346e27bc33908 |
|
MD5 | c08c7206b436d85c8efbf6aea107c186 |
|
BLAKE2b-256 | 134507808b7909a73860afc0fd28fab487554b1749bec92bef840d36f35f6046 |
File details
Details for the file lucidoc-0.4.4-py3-none-any.whl
.
File metadata
- Download URL: lucidoc-0.4.4-py3-none-any.whl
- Upload date:
- Size: 16.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7d29297940454f114e93919fea6346b700b316648603e4ce30ea43a58c2e173 |
|
MD5 | 0e2a1b08af2a2ce9de86c54f2a7080cc |
|
BLAKE2b-256 | 346377f89731a6430fe8ff2fcc0cebd693a15a9bef6c5b9064839be48cd81e4d |