Documentation for Redbrick
Available at docs.redbrick.dcu.ie and at the readthedocs.
Docs are automatically deployed on commit to master to readthedocs
The docs are built using mkdocs.
When you make a change make sure it works by building it locally.
Run:
make buildThis will test the docs build and if there are any dead links in them
To lint the Markdown locally, use this command (downloads very fast):
make lintTo bring up a local server with a copy of the docs just run
make serve