Update documentation - illinoistech-itm/py-mgipsim GitHub Wiki

Sphinx documentation generator is used in the gh-pages branch.
The documentation is automatically deployed to Github pages for every push to the main branch. Documentation can be modified by editing rst files in the docs/source folder.

To build it locally:

To install sphinx: pip install sphinx
To build the html: go to the docs folder and run: sphinx-build -M html ./source . -a
The output will be in the docs/html folder.
Sphinx will translate Google style docstrings (https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html) in the source code to html documentation.
Additional html documentation pages can be added by defining rst (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#paragraphs) files in the docs/source folder.
Currently sphinx uses a customized Read the docs theme, it can be further personalized.
The built HTML site can also be deployed locally by running in the docs/html folder: python -m http.server
Then it can be accessed via: http://localhost:8000/