documentation

Check rendered documentation from a PR

You can always check how the documentation changed in a PR renders on RTD. Go to the "check" section and click here:

Locally

We use ReadTheDocs with RST format. Below is the procedure for building the documentation locally:

Go into ivadomed's folder, activate ivadomed's virtual environment and install with the "docs" libraries:

pip install -e ".[docs]"
cd docs
make html
# Open page
open build/html/index.html