Building the Documentation

Follow these steps to build the docs:

# If not already done, clone the project repository.
git clone
# Enter the docs directory of the project.
cd hpc_submit_scripts/docs/
# Create a virtual Python environment called ".venv-docs".
python3 -m venv .venv-docs
# Activate the virtual Python environment.
source .venv-docs/bin/activate
# Upgrade pip, setuptools and wheel.
python3 -m pip install --upgrade pip setuptools wheel
# Install the requirements to build the docs.
python3 -m pip install --upgrade -r requirements-docs.txt

After installing all requirements, the documentation can be built via

# Create the documentation.
make html
# Check if the code examples in the documentation work as expected.
make doctest
# Deactivate the virtual Python environment.

To clean the build directory and remove all automatically generated files, run in the docs/ directory the following commands.

make clean
make clean_autosum