gempyor Sphinx auto-documentation

[emprzy]

Describe your changes.

This pull request uses Sphinx to generate documentation for the gempyor API, which is (loosely) defined right now as

• model_info.py,
• parameters.py,
• compartments.py,
• and inference.py.

Sphinx uses pre-existing inline docstring documentation to populate an HTML-coded table of contents with documentation of the submodules. You can find the index.html file at the path:
flepiMoP/flepimop/gempyor_pkg/src/gempyor/docs/build/html/index.html

By review, this PR should consolidate documentation for the gempyor API in an easy-to-navigate directory. Internal users can view documentation of select submodules, classes, and methods without using terminal. Eventually, this could be published for external use.

What does your pull request address? Tag relevant issues.

This pull request addresses GH #458.

[TimothyWillard]

I know this is still a draft/WIP so not looking too hard, but looks like the build directory contains the built documentation (I think this, or at least used to be, named _build)? If that's the case we should add that to the .gitignore and scrub those contents from b74f9d7.

[emprzy]

I know this is still a draft/WIP so not looking too hard, but looks like the build directory contains the built documentation (I think this, or at least used to be, named _build)? If that's the case we should add that to the .gitignore and scrub those contents from b74f9d7.

Sorry, I'm not really following what the implication of this is? Scrub what contents from b74f9d7?

[TimothyWillard]

I know this is still a draft/WIP so not looking too hard, but looks like the build directory contains the built documentation (I think this, or at least used to be, named _build)? If that's the case we should add that to the .gitignore and scrub those contents from b74f9d7.

Sorry, I'm not really following what the implication of this is? Scrub what contents from b74f9d7?

No worries. What I'm saying is:

1. Am I correct in understanding that flepimop/gempyor_pkg/src/gempyor/docs/build contains the built documentation? Built meaning the HTML files for viewing?
2. If (1) is yes, then add that directory to the .gitignore and remove the contents of that directory from b74f9d7.

Also, I'm just now noticing (after typing out the full file path above) that the docs are under the source files, that doesn't seem quite right? Shouldn't that be at the top of the python package directory, i.e. flepimop/gempyor_pkg/docs/? I know there's an existing directory there, but putting it under the source (i.e. where python will look to import and parse files) seems like a future problem waiting to happen if not one already.