This is the official repository of OpenNebula's Documentation. This documentation is live at: http://docs.opennebula.org.

You are encouraged to fork this repo and send us pull requests!

To create issues to report changes and requests, please use the OpenNebula main repository, with label Documentation.

Graphviz <https://graphviz.org/> is needed to compile the documentation.

Also the following Python dependencies:

pip install sphinx sphinx_rtd_theme sphinx-prompt sphinx_substitution_extensions pyyaml.

Build the documentation by running make html. More information.

$ make gettext
$ sphinx-intl update -c source/conf.py -p build/locale -l <lang>

Translate your po files under ./locale/<lang>/LC_MESSAGES/.

$ sphinx-intl build -c source/conf.py
$ make -e SPHINXOPTS="-D language='<lang>'" html

Follow this guide for more information.