-
Notifications
You must be signed in to change notification settings - Fork 39
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 cookbooks to docs #558
Add cookbooks to docs #558
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #558 +/- ##
=======================================
Coverage 93.54% 93.55%
=======================================
Files 92 92
Lines 6340 6343 +3
=======================================
+ Hits 5931 5934 +3
Misses 409 409 see 3 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
|
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.
Other than the directory structure and the two small comments, this looks good to me!
A simple setup of a rift in a Cartesian box, in which two plates are spreading at a constant spreading rate. | ||
The files can be found [here](https://github.com/GeodynamicWorldBuilder/WorldBuilder/tree/main/cookbooks/3d_cartesian_rift). | ||
|
||
The relevant part of the world builder file looks like this: |
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.
The relevant part of the world builder file looks like this: | |
The relevant part of the World Builder file looks like this: |
cookbooks/index.md
Outdated
Cookbooks | ||
====================== | ||
|
||
This section contains self contained cookbooks on how to design different geodynamic setups. Folders contain World Builder parameter files, grid output files, and optionally markdown files that are incorporated into the online documentation and explain particular features about the setup. |
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.
This section contains self contained cookbooks on how to design different geodynamic setups. Folders contain World Builder parameter files, grid output files, and optionally markdown files that are incorporated into the online documentation and explain particular features about the setup. | |
This section contains self-contained cookbooks on how to design different geodynamic setups. Folders contain World Builder parameter files, grid output files, and optionally a doc folder that contains relevant figures and markdown files that are incorporated into the online documentation and explain particular features about the setup. |
Or if you have a good idea for how not to repeat 'contained' that would be even better.
3c5e302
into
GeodynamicWorldBuilder:main
Add a changelog entry for #558
This PR removes the directory
doc/sphinx/user_manual/cookbooks
and replaces it with a soft link to the directorycookbooks
. This way the cookbooks remain in a top level directory, but also appear in the online documentation. Now we can add markdown files (and other files like images) in the cookbooks like I have done here for the 3D Cartesian rift cookbook. This also adds a minimal example for how cookbook documentation can look like.