https://github.com/opennebula/docs

OpenNebula Documentation
https://github.com/opennebula/docs

Last synced: about 1 year ago
JSON representation

OpenNebula Documentation

• Host: GitHub
• URL: https://github.com/opennebula/docs
• Owner: OpenNebula
• License: other
• Created: 2013-12-09T15:55:23.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-04-12T10:31:48.000Z (about 2 years ago)
• Last Synced: 2024-04-12T16:40:02.916Z (about 2 years ago)
• Language: HTML
• Size: 113 MB
• Stars: 45
• Watchers: 19
• Forks: 177
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
OpenNebula Documentation

========================

![Make Html](https://github.com/OpenNebula/docs/actions/workflows/make_html.yml/badge.svg)

This is the official repository of OpenNebula's Documentation. This

documentation is live at:

[http://docs.opennebula.org](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](https://github.com/OpenNebula/one), with label Documentation.

Building

--------

`Graphviz ` 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](http://sphinx-doc.org/).

Spell checking

-------------

`sphinxcontrib.spelling 

### Translate

Translate your po files under ``./locale//LC_MESSAGES/``.

### Publish the translation

    $ sphinx-intl build -c source/conf.py

    $ make -e SPHINXOPTS="-D language=''" html

### More Info

Follow [this guide](http://sphinx-doc.org/intl.html) for more information.