***********************************
README xAAL project's documentation
***********************************

Introduction
============
This README deals with the xAAL project's documentation.
The documentation is generated with sphinx and we are using the official theme
of ReadTheDocs.


Requirements
============

We are using the official theme of ReadTheDocs.

Consequently, download the package:

.. code-block:: bash

    $ pip install sphinx_rtd_theme

In ``conf.py`` file (generated after a sphinx-quickstart for example):

.. code-block:: python

    import sphinx_rtd_theme
    html_theme = "sphinx_rtd_theme"
    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]


Contribute
==========
To contribute, simply edit one of the file in the source directory.


Build and Visualize
===================

To check the documentation locally you can make:

.. code-block:: bash

    $ make html
    $ cd build/html
    $ open build/html/index.html