nova-top-level-docs

=======================

Introduction

This is the repository for the nova-top-level-docs. This project creates the documentation at https://nova-application-development.readthedocs.io/en/latest

Formatting

poetry run ruff format

Linting

poetry run ruff check
poetry run mypy .

Build docs

docker build -f dockerfiles/Dockerfile --target source -t image .
docker run -u `id -u`:`id -g` image bash build_docs.sh

CI/CD in GitHub

Take a look at the .github/workflows folder. Actions to lint and test your code will run automatically on each commit. The action for building and releasing this package needs to be triggered manually.

Publishing docs to readthedocs.io

This repo has a webhook that automatically triggers documentation builds on readthedocs.