*************************** Write / Build Documentation *************************** MORe documentation is written with `Sphinx`_, a tool which was designed for the documentation of Python projects. Write Documentation Content =========================== The documentation source files (`.rst`) are placed in the `doc` directory of the `master` branch. They are written with the markup language `reStructuredText`_. The main file is `index.rst`, which includes all other files. Project details, such as the version, release, etc., are configured in the `conf.py` file. Build the Documentation ======================= The html files are to be placed in a separate branch named `gh-pages`. The static html content of this branch is automatically displayed at http://spescha.github.io/MORe. See `Publishing sphinx-generated docs on github`_ for more details. To build the documentation, the easiest way is to call the :code:`sphinx-build ` from the command line, whereas is the `doc` directory and is the path to your `gh-pages` copy. .. _reStructuredText: http://www.sphinx-doc.org/en/1.4.9/rest.html .. _Sphinx: http://www.sphinx-doc.org/ .. _Publishing sphinx-generated docs on github: https://daler.github.io/sphinxdoc-test/includeme.html