-
Notifications
You must be signed in to change notification settings - Fork 14
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
Cm/docs pmap #218
base: main
Are you sure you want to change the base?
Cm/docs pmap #218
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #218 +/- ##
==========================================
+ Coverage 75.13% 77.75% +2.62%
==========================================
Files 5 5
Lines 559 562 +3
==========================================
+ Hits 420 437 +17
+ Misses 139 125 -14 ☔ View 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.
Talk starting.
docs/Manifest.toml
Outdated
@@ -0,0 +1,2734 @@ | |||
# This file is machine-generated - editing it directly is not advised |
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.
We shouldn't check in the docs manifest.
docs/assets/sharp_op.jl
Outdated
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.
@lukem12345 do we still need this file, or did it get upstreamed?
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 is upstreamed. The file that include
s this sharp implementation should have its include
of this removed, and the generate
function can also get pruned.
push!(pages, "Overview" => "overview.md") | ||
push!(pages, "Equations" => "equations.md") | ||
push!(pages, "BC Debug" => "bc_debug.md") | ||
push!(pages, "ASCII Operators" => "ascii.md") |
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.
since this part is being hard coded, it could still be a Vector{Pair{String,String}}
literal and then you can push to it for the dynamically generated part later.
docs/make.jl
Outdated
# end | ||
# # push!(examples, exampledirs[d] => dir_dict) | ||
#end | ||
#push!(pages, "Examples" => examples) |
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.
remove dead code.
docs/make.jl
Outdated
# ], | ||
# "Canonical Models" => "canon.md", | ||
# "Library Reference" => "api.md" | ||
# ] |
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.
ded code
docs/src/ice_dynamics.md
Outdated
@@ -1,528 +0,0 @@ | |||
# Halfar's model of glacial flow |
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.
why did we delete this page?
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.
It looks like docs\src\grigoriev.md
was errantly git mv
’d to docs\src\climate\ice_dynamics.md
, and the real docs\src\ice_dynamics.md
was deleted.
It looks like the history for grigoriev.md is incorrect now |
Comment out the brusselator example and see if works @quffaro |
This branch was created when main had docs which were formatted agreeably with Literate. Therefore the other branches related to this task, pending inspection, should be disregarded. This
make.jl
file partially automates adding examples to our docs. In a future branch: