Feature: Added Sphinx documentation and GH workflow for docs hosting using Github Pages

[daphne-cornelisse]

Description

This pull requests adds Sphinx documentation and hosted docs using Github Pages to the EMERGE Nocturne package.

Changes Made

The following changes were made in the feature/add_sphinx_docs branch:

• Sphinx docs:
  • Added Sphinx documentation with initial documentation skeleton
• Github workflow & Github Pages:
  • Added simple Github workflow for hosting Sphinx docs using Github Pages

Related Issues

This pull request resolves the no outstanding issues.

Review checklist

• Review file changes
• Build and review docs locally, steps:
  • Install documentation requirements, either poetry install --only=docs or pip install -r ./requirements.docs.txt
  • Build Sphinx docs by running cd docs; make html; cd ..
  • Open and review docs locally by opening ./docs/build/index.html in your browser of choice
• Test Github workflow and review Github Pages docs
  • Go to Github actions and launch Github Pages deployment: https://github.com/Emerge-Lab/nocturne/actions/workflows/run_build_docs.yml
  • Verify docs build and Github Pages deployment succeeded
  • Review Github Pages docs at https://emerge-lab.github.io/nocturne/

[eugenevinitsky]

Should I review this?

[daphne-cornelisse]

No, I will look at how to reduce the number of notifications for these things

…

On Monday, October 9, 2023, Eugene Vinitsky ***@***.***> wrote: Should I review this? — Reply to this email directly, view it on GitHub <#3 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AH7I7P3GXYOFOB3BU6NAKLLX6QSRRAVCNFSM6AAAAAA5Q47MDWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONJTGMZTONRYGQ> . You are receiving this because you were assigned.Message ID: ***@***.***>

[eugenevinitsky]

Oh I idn't get a notification, I was just futzing around