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. Start local server and watch for changes:

    just docs
  2. Open in your browser to view the docs.


An alternative port can be specified using the port variable: just port=3000 docs

Verifying documentation

To check that all hyperlinks are live:

just check-links