mirror of
https://github.com/zama-ai/concrete.git
synced 2026-02-09 03:55:04 -05:00
cbdadef9fb
we want to automatically create links to python file in case there is some changes to the package. We still need to do link creation for dialect files manually.
Bibliotech
Documentation is built with sphinx (https://www.sphinx-doc.org).
Dependencies
In the docs repository (which contains this file):
It is recommended to first create a virtualenv:
virtualenv .venv
source .venv/bin/activate
You need to install the Python dependencies:
pip install -r requirements.txt
pip install -r ../llvm-project/mlir/python/requirements.txt
You also need to install Doxygen.
Build local docs
make doc
To open the docs:
xdg-open _build/html/index.html
Automatic build on update
If you want the documentation to be updated as you are editing it, you can install an extra package called sphinx-autobuild
pip install sphinx-autobuild
and launch (after a run of make doc) in the doc directory:
python -m sphinx_autobuild . _build
This will launch a local web server on port 8000 with updated rendered version on each source modifications (but doesn't work on dialects changes, for which make doc need to be run again).