CloudSim Plus Documentation

This directory contains the sources to generate several different kinds of CloudSim Plus documentation. You can browse the online documentation here.

The documentation includes:

• FAQs and guides in reStructuredText (rst) format to be published at ReadTheDocs site;
• StarUML project containing UML diagrams;
• Side-by-Side comparison between CloudSim and CloudSim Plus java simulation scenarios (online version available here);
• White Paper published at the EU/Brasil Cloud FORUM.
• Web Slides presenting CloudSim Plus (online version available here).

Building the reStructuredText files for the Documentation Site

To generate the Sphinx documentation to read locally, considering you have python installed, you can execute make install to install the additional tools.

Ensure you have the following environments variables declared, since the python scripts use UTF-8 encoding:

export LC_ALL=en_US.UTF-8
export LANG=en_US.UTF-8

To build the documentation in html use:

make html

After that, you can navigate the generated documentation locally by accessing the _build directory. To publish the updated documentation to ReadTheDocs site, just commit any changes (which don’t include the _build directory) and push them to GitHub.