This program generates HTML documentation for Python projects by parsing the source code using Python's AST module. As such the source code is not loaded, it never reaches the interpreter and side-effects are effortlessly avoided.
This projet targets Python 3.5 and above.
- AST-based Python parsing
- Fully
setup.py-based configuration - MD/RST docstrings support
- Additional files inclusion as separate doc sections
- Built-in HTTP live-server
- Single HTML, PDF or Markdown artifact
- Symbol resolution, allowing linking through symbols within the document
- JPEG/PNG media inclusion (only one final artifact)
- In-document Graphviz processing
This is fairly straighforward:
pip install adoc
If you wish to output PDF documentation you'll need to install a different
flavour of adoc:
pip install adoc[pdf]
For iteractive generation:
adoc --http .
For an HTML export:
adoc --html docs/index.html .
Prepare a virtual environment:
python -m venv env
source env/bin/activate
pip install -r requirements.txt
pip install -r requirements-pdf.txt
pip install -r requirements-test.txt
Run the test suite:
pytest .
To start the web server:
python -m adoc --http .