Update docs and add doctests #175
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Benchmark Results (Julia v1.10)Time benchmarks
Memory benchmarks
|
Benchmark Results (Julia v1)Time benchmarks
Memory benchmarks
|
|
Hi @abhro, hope you've been well! I love this PR and just wanted to check back in about its current status. I think getting it in would be really helpful for keeping the docs in sync with the |
|
Hi! I think I've addressed all the changes, it's most likely just the CI checks now |
|
Oh, could we also add the generated |
|
Done! |
|
Sweet, thanks! Have you been able to generate docs with the |
I'm guessing this part is meant for @MilesCranmer? I'm not sure I can offer much help on the deployment side of things |
|
Sorry, I should have said "because of the Mirror to DAMTP bit" instead of "with the Mirror to DAMTP bit". In other words, this seems like an issue for anyone trying to build the docs locally, so I just wanted to see if we could smooth that process out a bit for folks. Similarly, I was wondering if it might also be good to add a tip about using LiveServer.jl with something like: servedocs(; include_dirs=["src/"], skip_files=["docs/src/index.md"])so things work well from the jump. Anyway, just wanted to get your perspective to get an idea of if something like this would be helpful or not, haha |
Mmm, yes, that's probably a good idea to add a guard to check if the build is happening in CI or not. |
|
Cool how about just wrapping the deploydocs bit in something like this? in_CI_env = get(ENV, "CI", nothing) == "true"
if in_CI_env
deploydocs(;
repo="github.com/SymbolicML/DynamicQuantities.jl",
devbranch="main"
)
# Mirror to DAMTP:
ENV["DOCUMENTER_KEY"] = ENV["DOCUMENTER_KEY_CAM"]
ENV["GITHUB_REPOSITORY"] = "ai-damtp-cam-ac-uk/dynamicquantities.git"
deploydocs(;
repo="github.com/ai-damtp-cam-ac-uk/dynamicquantities.git",
devbranch="main"
)
end |
|
That looks ok but the environment variable should be more specific. Like “DEPLOY_DOCUMENTER” or something. And just have the default be “false” rather than nothing |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #175 +/- ##
=======================================
Coverage 99.21% 99.21%
=======================================
Files 21 21
Lines 1273 1273
=======================================
Hits 1263 1263
Misses 10 10 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Sweet, thx! Could you also add that CI guard Miles mentioned? |
Please see the commmit messages for relevant changes