add docs-generating script that allows for specifying input and output path #1466
+35
−9
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sfonxu
changed the title
slayoo
requested changes
Dec 13, 2024
.github/workflows/docs.py
Outdated
| os.chdir(code_path) | ||
| os.environ["PDOC_ALLOW_EXEC"] = "1" | ||
|
|
||
| for notebook_path in glob.glob("examples/PySDM_examples/*/*.ipynb"): |
There was a problem hiding this comment.
we could use the devops_tests find_files function that limits the search to files tracked in git: https://github.com/open-atmos/devops_tests/blob/8eb4d96a1ea8afa09a409a99dccbd0ddd48f80a7/utils.py#L10
|
Thanks @Sfonxu! I've added a few comments that could help make the code more bullet-proof |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1466 +/- ##
=======================================
Coverage 85.22% 85.22%
=======================================
Files 376 376
Lines 9265 9265
=======================================
Hits 7896 7896
Misses 1369 1369 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
regarding #1445