Technical processes

• Standard repository
  • Branches and tags
  • Structure
• Building the documentation
  • Get started
  • Build the documentation
  • View development documentation on readthedocs
• Update the schema and codelists from Airtable
• Deploying the documentation
  • Read the Docs configuration
  • Prepare for release
  • Merge and release
  • Complete the deployment

Running tests locally

When you push code to GitHub, tests are automatically run. You will not be allowed to merge your pull request until these tests pass.

To run these locally, first create and install a virtual environment as instructed on the build page.

To run tests locally, run:

pytest tests/

To build the project while checking for warnings, run:

sphinx-build -nW ./docs/ ./temp_build