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<7.3' sphinx_rtd_theme sphinx-prompt sphinxcontrib-spelling pyyaml sphinx-substitution-extensions.
Build the documentation by running make html.
More information.
sphinxcontrib.spelling <https://sphinxcontrib-spelling.readthedocs.io/en/latest/index.html is needed to run the spell checker.
Also, the following Python dependencies:
pip install sphinxcontrib-spelling pyenchant
And the python3-enchant package:
sudo apt install python3-enchant
If the spellchecker job fails for your branch, you can check the job log which will display the file + word that didn't pass the spell checker along with some suggestions.
Either you will have to correct the typo and push it again, or if it's a false positive, you can update the custom wordlist used at source/ext/spellchecking/wordlists/opennebula.txt
$ 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.