We use MkDocs to generate the documentation with the MkDocs Material theme.

From the root directory:

1. Install RL4CO locally

pip install -e ".[dev,graph,routing,docs]"

note that docs is the extra requirement for the documentation.

2. To build the documentation, run:

mkdocs serve

We are using the hooks.py for additional modifications. MkDocs for instance cannot detect files that are not in the same directory as an __init__.py (as described here) so we are automatically creating and deleting such files with our script