Skip to main content

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

This version
History Node

0.0.4

History Node

0.0.2

History Node

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
biblio-0.0.4.tar.gz (28.4 kB) Copy SHA256 hash SHA256 Source None Jul 17, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page