Usage

Building Documentation

To build the documentation:

  1. Activate your virtual environment:

    source docs_env/bin/activate  # On Windows: docs_env\Scripts\activate
    
  2. Navigate to the docs directory:

    cd docs
    
  3. Build the HTML:

    make html
    

The built documentation will be in _build/html/.

Updating Documentation

  1. Edit the relevant .rst files

  2. Rebuild the documentation:

    make clean
    make html
    
  3. View your changes in _build/html/index.html