Documentation

[bpepple]

This pull request will add some documentation to the project.

First thing you'll want to do is install the optional doc dependencies. These are needed since poetry is a realitively new project and doesn't have proper support with ReadTheDocs. To add them you need to run poetry install -E docs.

To create the documentation locally, you would change to the docs directory and run make html. The results can be then found in docs/build/html directory.

If a new module is added to the project, you will need to go to the docs directory and run sphinx-apidoc -o source ../Simyan to have that module's documentation added.

To host the documentation at ReadTheDocs, the first thing you need to do is create an account there. Once there you should be able to import the repo. I've already added a readthedoc.yml to the project so there should not be much configuration needed, but if you into any problems just holler.

[bpepple]

Oh, one thing I forgot. The project didn't seem to be using the standard __version__ when the it's being initialized, and for the documentation it's useful to have. So, when you publish new releases you need to make sure to update the values in the project.toml & the project __init__.py.

[Buried-In-Code]

@bpepple are you ok with fixing these conflicts?

[bpepple]

I can give them a look later tonight