Skip to content

gw4-isambard/docs

Repository files navigation

GW4 Isambard Documentation

This repository contains the user documentation for the Isambard Tier-2 HPC facility.

Contributing

Full advice on contributing to this project is given in CONTRIBUTING.md.

Anyone is welcome to contribute to this documentation via GitHub's pull request feature. Start by forking the repository and cloning it to your local machine.

The documentation is generated using sphinx, with pages written using the reStructuredText format. You will need to install sphinx to build the documentation locally (available from most package managers or via pip install sphinx. Run make html to build the HTML documentation, which is generated into the _build/html/ directory.

After you have pushed your changes to your fork on GitHub, open a pull request to submit your contributions.