an extremely fast and simple documentation generator
Project description
# biblio
biblio is an extremely fast and simple documentation generator for Python. At its core, biblio is just a wrapper that transalates Pythons native AST into a structure that can then be formatted and outputted.
## Architecture
Unlike Sphinx, biblio does not run any of your code, only parse it. This results in a much faster and more reliable documentation generation process. Using the AST also allows biblio to generate rich and in-depth output.
## TODO
biblio is fukin wip man
Implement methdology for linking/parsing out types in data - We need to somehow extract types and modify the parsed docstrings to include links
Proper HTML output - Theme - Search
Write docs - Hightlight metaprogramming struggle
Allow for live outputting w/ inotify
Multiprocessing
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
File details
Details for the file biblio-0.0.4.tar.gz
.
File metadata
- Download URL: biblio-0.0.4.tar.gz
- Upload date:
- Size: 28.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0a306bf4f11cad46c247ccfba8ad778ce455573aa919bc3b69c62c610ca0f1b |
|
MD5 | 4db855de93318631cbb28b4e764e3ca3 |
|
BLAKE2b-256 | 3f7f765ac424de7a774c2d2626ac869ba691eb176cdd8947af9fd604b2d86ec4 |