Building the Rain DocumentationΒΆ

The documentation has been created using Sphinx and therefore you have to build it before you can see the final html files. The source files of the documentation can be found under the doc directory of our software package. Next, we define the needed steps to build the documentation.

  1. Install the documentation Using a source tarball or Downloading the latest code from GitHub.

  2. Change your current directory to the doc one.

    cd doc
  3. Build the documentation using the Makefile.

    make website
  4. The documentation should be in the directory build/web-<version>/. This basically contains html files that can be copied to a regular http server.