WayScience / coSMicQC

Single cell Morphology Quality Control (coSMicQC)
https://wayscience.github.io/coSMicQC/
BSD 3-Clause "New" or "Revised" License
7 stars 3 forks source link

Add docsite #73

Closed d33bs closed 3 months ago

d33bs commented 3 months ago

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).

image image

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.

review-notebook-app[bot] commented 3 months ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

d33bs commented 3 months ago

Thanks @jenna-tomkinson ! Merging this in after addressing your comments.