ESSIMDocs

Project for creating the ReadTheDocs pages for the ESSIM Documentation

The docs directory contains the documentation information

Online documentation

This documentation is hosted at: https://essim-documentation.readthedocs.io/

Get up to speed

To generate the documentation:

cd docs
make html

Then the html is generated in the directory docs\build\html. Open the index.html in that directory in your browser to see your changes.

When you push the changes to the github repository, the online documentation is automatically generated within a few minutes.