Add DSCIM mkdocs documentation page#254
Add DSCIM mkdocs documentation page#254kemccusker merged 3 commits intoClimateImpactLab:mainfrom JMGilbert:main
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #254 +/- ##
=======================================
Coverage 65.63% 65.63%
=======================================
Files 17 17
Lines 1845 1845
=======================================
Hits 1211 1211
Misses 634 634 ☔ View full report in Codecov by Sentry. |
brews
left a comment
There was a problem hiding this comment.
Nice. Thanks for this, @JMGilbert . I think you're giving this a pretty good starting point, like you said. We can definitely build off of this.
There was some discussion (@kemccusker) about trying to deploy this to readthedocs, and seeing how that feels. There are good arguments for that. But, given how busy we've been and it has taken 3 weeks to review this, I think it's okay to start this on Github Pages (which is simpler). We can test the waters with mkdocs on readthedocs in a later PR.
Curious to hear others opinions, especially if there is disagreement. I think it's okay to merge this as is. I'm happy to setup the Github Pages settings when/if we're ready.
|
@brews @JMGilbert I'm totally down with starting these docs on GitHub pages. I'd be happy for you to take that on, Brewster. Thanks both! |
Documentation was built based on the dodola repository. The current documentation for dscim can be viewed here: https://jmgilbert.github.io/dscim/.
This page at some point could use a revamp of the readme and some of the docstrings. I think it makes more sense to have that be a separate PR.