Move examples to Literate.jl #193
Merged
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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #193 +/- ##
==========================================
+ Coverage 85.05% 85.67% +0.61%
==========================================
Files 9 9
Lines 649 649
==========================================
+ Hits 552 556 +4
+ Misses 97 93 -4 ☔ View full report in Codecov by Sentry. |
musoke
force-pushed
the
docs/literate
branch
9 times, most recently
from
647ada5
to
cd57381
Compare
Currently running the examples (and tests that include them) generates data in the working directory. Move this to temporary directories that are cleaned up automatically on exit.
musoke
force-pushed
the
docs/literate
branch
5 times, most recently
from
936a4a8
to
76c3031
Compare
Literate.jl eases rendering scripts and their output in documentation built by Documenter.jl. This should make the examples much more prominent and keep them up to date. This commit refreshes the MPI/PencilGrids example and uses Literate.jl to render it in the docs.
musoke
force-pushed
the
docs/literate
branch
2 times, most recently
from
42649f0
to
529c24d
Compare
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.
No description provided.