README.md

Docs

Documentation for Redbrick

Available at docs.redbrick.dcu.ie and at the readthedocs mirror.

The readthedocs mirror is automatically deployed on commit to master. The docs site is a scheduled cron job on halfpint that git pull && mkdics build once an hour to up date the docs.

The docs are built using mkdocs. To bring up a local server with a copy of the docs just run

docker-compose up docs

To build the docs just run

docker-compose up -d docs

Testing locally

When you make a change make sure it works by building it locally.

Run:

docker-compose run --rm docs mkdocs build
docker-compose run --rm test

This will test the docs build and if there are any dead links in them