-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add .devcontainer + .vscode/extensions.json #452
Conversation
In the past the DefaultForcing.generate() and load() methods had docstrings that rendered the model_specific_options of some models. Now those models are in their own repos, so no longer need it here.
As recommonmark is deprecated myst-nb has myst-parser as deps, so any *.md will also be processed by myst
autodoc2 does not handle google style docstrings so we switch back to the original autoapi.
TODO * [ ] edit python file * [ ] ewatercycle env activated * [ ] navigation * [ ] ruff * [ ] mypy * [ ] in terminal * [ ] ewatercycle env activated * [ ] ruff * [ ] mypy * [ ] pytest Refs #441
Use removeEnv to set path + set envs in dockerfile
Quality Gate passedIssues Measures |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #452 +/- ##
=======================================
Coverage 78.93% 78.93%
=======================================
Files 28 28
Lines 1804 1804
Branches 216 216
=======================================
Hits 1424 1424
Misses 323 323
Partials 57 57 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First I used the link on the badge, but that didn't work correctly yet (as it refers to the main branch).
Manually cloning the repo and checking out this branch worked:
- dev container installed successfully
- specified VS Code extensions were installed automatically
pytest
ran sucessfully inside the dev containercd docs; make html
generated the docs no problem
Nice work! 😄
Can you add a short mention of this VS Code dev container setup in the CONTRIBUTING.md file? That would allow others to find it more easily.
TODO
Refs #441