Updating documentation

The R2DT documentation is generated using Sphinx and MyST. The docs are deployed automatically to Read the Docs.

To generate documentation locally:

  1. Create a local virtual environment and activate it:

    just venv
  2. Generate html files and automatically rebuild on changes:

    just docs
  3. Open http://localhost:8000 in your browser to view the docs.

  4. To check that all URLs are live:

    just check-links