The users manual is maintaining using Sphinx, a documentation tool written in python. The easiest way to setup sphinx (and python) environment is to install Anaconda, which enables you to install sphinx package using anaconda navigator.
To build the html files, type the following command in the top of working directory:
$ make html
The outputs are written under the build/html
directory.
In our repository, build/html
is a symbolic link to doc
directory, the location published as https://rcsoccersim.github.io/manual.
If successfully built, you can browse the local html files by your favorite web browser. Please note that the docs directory will be immediately published as our web site if changes are pushed to the master branch. In order to avoid useless conflicts, please fork the official repository or create another branch, then push only source (.rst) files and create a pull request.