This documentation covers aspect of running CHBH-on-BEAR workflows on the University of Birmingham's BlueBEAR HPC system.

The documentation is automatically built and published to https://ajquinn.github.io/chbh-on-bear on every push to the main branch of this repository.

This is taken care of by the deploy GitHub Actions workflow.

To install all the required mkdocs Python packages, use the provided requirements.txt file. The recommendation for development is to do this inside a dedicated virtual environment:

git clone https://github.com/AJQuinn/chbh-on-bear
cd chbh-on-bear
python -m venv ./.venv
source ./.venv/bin/activate
pip install -r requirements.txt

To build the documentation, use:

mkdocs build

To test whether the documentation is building correctly, and whether all (internal) links are correct, use:

mkdocs build --strict

This command will exit with a non-zero exit code if mkdocs produces any errors or warnings.

To see a local preview of the rendered documentation in your browser, use

mkdocs serve

and click the link that is provided, for example:

INFO     -  Documentation built in 0.24 seconds
INFO     -  [17:52:07] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO     -  [17:52:07] Serving on http://127.0.0.1:8000/

This preview of the rendered documentation will automatically refresh when the documentation sources are updated!