https://github.com/b1naryth1ef/biblio
biblio is an extremely fast and simple documentation generator for Python
https://github.com/b1naryth1ef/biblio
docs documentation python
Last synced: 15 days ago
JSON representation
biblio is an extremely fast and simple documentation generator for Python
- Host: GitHub
- URL: https://github.com/b1naryth1ef/biblio
- Owner: b1naryth1ef
- Created: 2017-04-14T06:35:58.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-17T17:25:35.000Z (almost 9 years ago)
- Last Synced: 2025-02-28T08:30:09.068Z (over 1 year ago)
- Topics: docs, documentation, python
- Language: Python
- Size: 45.9 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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