Skip to content

Add DSCIM mkdocs documentation page#254

Merged
kemccusker merged 3 commits intoClimateImpactLab:mainfrom
JMGilbert:main
May 30, 2024
Merged

Add DSCIM mkdocs documentation page#254
kemccusker merged 3 commits intoClimateImpactLab:mainfrom
JMGilbert:main

Conversation

@JMGilbert
Copy link
Copy Markdown
Contributor

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.

@JMGilbert JMGilbert requested review from brews and kemccusker May 6, 2024 16:25
@codecov
Copy link
Copy Markdown

codecov bot commented May 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.63%. Comparing base (d4ab702) to head (339ed7a).

❗ Current head 339ed7a differs from pull request most recent head 416aa5b. Consider uploading reports for the commit 416aa5b to get more accurate results

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.
📢 Have feedback on the report? Share it here.

Copy link
Copy Markdown
Member

@brews brews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@kemccusker
Copy link
Copy Markdown
Member

@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!

@kemccusker kemccusker merged commit 8c3e7c5 into ClimateImpactLab:main May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants