Iceberg Documentation

Iceberg is The University of Sheffield's High Performance Computing cluster. The current official documentation for it is at https://www.shef.ac.uk/wrgrid/iceberg.

This repository contains a proposed replacement for the page linked to above. It makes use of Sphinx to build the results and represents a move to a more open, collaborative way of working.

For a guide on the rst file format see this document.

Rendered Documentation

Two versions of the documentation are currently automatically built from this repository:

• A website
• A .pdf document

How to Contribute

Contribution is via githib Pull Requests, even for those who have direct commit access to the repository. To contribute, please fork this repo, make your changes in the fork and submit a Pull Request when you are ready.

Building the documentation locally

It is also possible to build the documentation on your own machine. Clone the repository and follow the instructions below

Building the documentation on a local Windows machine

Install the following:-

• Anaconda Python

Install the following module

 pip install sphinx_bootstrap_theme

• GNU Make
• MikTeX

From the command line, the following will build the .pdf file ::

make latexpdf

On first run, MikTeX will prompt you to install various extra LaTeX packages. To build the HTML documentation ::

make html

Building the documentation on a local Linux machine

Have

• Python 2
• sphinx
• phinx_bootstrap_theme

installed, then run ::

 make html

Building the documentation on a local Mac machine

TODO