mozhgan-kch / jade-hpc Goto Github PK

This is the source code for the documentation of JADE HPC facility user guide. It is written in the rst format. For a guide on the rst file format see this document.

To contribute to this documentation, first you have to fork it on GitHub and clone it to your machine, see Fork a Repo for the GitHub documentation on this process.

Once you have the git repository locally on your computer, you will need to install sphinx and sphinx_bootstrap_theme to be able to build the documentation. See the instructions below for how to achieve this.

pip install sphinx_bootstrap_theme

Once you have made your changes and updated your Fork on GitHub you will need to Open a Pull Request. All changes to the repository should be made through Pull Requests, including those made by the people with direct push access.

1. Install Python on your machine

2. Install sphinx and sphinx-autobuild:

   pip install sphinx sphinx-autobuild
   

3. To build the HTML documentation run:

   make html
   

   Or if you don't have the make utility installed on your machine then build with sphinx directly:

   sphinx-build . ./html
   

4. Build the documentation:

   make html
   

The package sphinx-autobuild provides a watcher that automatically rebuilds the site as files are modified. To use it, install (in addition to the Sphinx packages) with the following:

pip install sphinx-autobuild

To start the autobuild process, run:

make livehtml

The application also serves up the site at port 8000 by default at http://localhost:8000.

The documentation consists of a series of reStructured Text files which have the .rst extension. These files are then automatically converted to HTMl and combined into the web version of the documentation by sphinx. It is important that when editing the files the syntax of the rst files is followed.

If there are any errors in your changes the build will fail and the documentaion will not update, you can test your build locally by running make html. The easiest way to learn what files should look like is to read the rst files already in the repository.