Building Documentation

This page documents how to build the documentation. You can use these steps to check everything displays correctly locally before pushing changes.

1. Ensure you are in your virtual environment

2. Install dependencies (for docs and DynAIkonTrap project):

   cd docs
   pip install -r requirements.txt && pip install -r ../requirements.txt
   

3. Build documentation:

   make clean && make html
   

4. Navigate a browser to .../docs/build/html/index.html