Initial documentation

[manjavacas]

Energym documentation is out!

• Resolves Documentation #12
• Resolves Document the use with vscode #18

Here is a first version of the documentation, with some important changes:

• The vast majority of the current source code have been documented using Sphinx. I've followed Google standard due to its readability, but it can be changed to any format we want by simply using Sphinx plugins.
• The README has been updated with additional information (ie. VS container).
• Part of the code has been cleaned up and reformatted.

In this first version, the documentation is organized similarly to the README and contains almost the same content. The objective will be to complete the documentation with more sections as we come up with.

In order to compile the documentation and use the ReadTheDocs theme you need to install:

pip install sphinx
pip install sphinx_rtd_theme

These dependencies could be added to the container.

In the build folder you will find the last html files associated with the documentation. To view them open: doc/build/html/index.html (here).

Here is a preview:

The project documentation should be ready to be exported to ReadTheDocs as soon as we have this first version in the master branch.

I look forward to your comments!

Cheers

[miguems]

Great job! As the readme is quickly growing in size, we should add a table of contents at the beginning.
Apparently cannot be done automatically in Github, but vscode can help

[jgromero]

Looks very good!

[jajimer]

Awesome! :)