This pull request adds docsite (documentation website) capabilities for coSMicQC through the use of Sphinx and related tools. I've added some guidance on how this is developed / built in the contributing.md documentation (which was also moved to help coordinate the location of the documentation).
There were a number of Sphinx-related dependencies which no longer adequately support Python 3.8. After consulting with @jenna-tomkinson on this, we decided to remove Python 3.8 support (Python 3.9 will be the minimum requirement for using coSMicQC after this PR).
Closes #7
Closes #19
Previews (note: these simulated version v0.0.12 to help with the versioning display due to how versioned documentation functions).
What kind of change(s) are included?
[x] Documentation (changes docs or other related content)
[ ] Bug fix (fixes an issue).
[ ] Enhancement (adds functionality).
[ ] Breaking change (these changes would cause existing functionality to not work as expected).
Checklist
Please ensure that all boxes are checked before indicating that this pull request is ready for review.
[x] I have read and followed the CONTRIBUTING.md guidelines.
[x] I have searched for existing content to ensure this is not a duplicate.
[x] I have performed a self-review of these additions (including spelling, grammar, and related).
[x] These changes pass all pre-commit checks.
[x] I have added comments to my code to help provide understanding
[ ] I have added a test which covers the code changes found within this PR
[x] I have deleted all non-relevant text in this pull request template.
Description
This pull request adds docsite (documentation website) capabilities for coSMicQC through the use of Sphinx and related tools. I've added some guidance on how this is developed / built in the contributing.md documentation (which was also moved to help coordinate the location of the documentation).
There were a number of Sphinx-related dependencies which no longer adequately support Python 3.8. After consulting with @jenna-tomkinson on this, we decided to remove Python 3.8 support (Python 3.9 will be the minimum requirement for using coSMicQC after this PR).
Closes #7 Closes #19
Previews (note: these simulated version v0.0.12 to help with the versioning display due to how versioned documentation functions).
What kind of change(s) are included?
Checklist
Please ensure that all boxes are checked before indicating that this pull request is ready for review.