Init Sphinx Docs

[joey-kilgore]

Overview

This is an initial sphinx documentation that generates HTML webpages automatically upon any commit/pull request with main. The base of the docs was generated using sphinx-quickstart to create the general files. Additionally I used sphinx-apidoc -o ./source ../superneuroabm which helped generate the various .rst files. Using this you can run the following commands (which are in the docs.yaml workflow) to generate the docs.

pip install .
cd docs
make html

These are very preliminary, but it generates the main files in docs/build/html that can be connected to github pages for deployment.

To see this deployed checkout my fork - https://joey-kilgore.github.io/superneuroabm/

Specifics on changes

.gitignore - ignores the extra files from the docs, as well as standard python generated files that should be ignored (including a virtual environment)
docs - all of this is the generated files from sphinx
setup.py - add the additional dependencies needed for building docs/development (sphinx)

Notes for project admin

To deploy this documentation the following steps need to be taken:

1. go to the project settings
2. go to the pages tab
3. select deploy from branch and choose branch gh-pages and the /root directory

Once this is merged and the action runs, it will take a few minutes but then will automatically deploy.