Various docs tasks for consistency

CliMA / CalibrateEmulateSample.jl

Stochastic Optimization, Learning, Uncertainty and Sampling

https://clima.github.io/CalibrateEmulateSample.jl/dev

Apache License 2.0

81 stars 14 forks source link

Various docs tasks for consistency #271

Closed odunbar closed 6 months ago

odunbar commented 6 months ago

Purpose

Closes #270 Closes #274

Content

Adds new Sinusoid example images and link into landing page, reorganize landing page. Landing page
Rearrange docs pages order (for cleaner contents)
Rename "Package-design/API for AbstractMCMC" -> "Sample"
Adds a user interface section into the "Sample" page at the top. Bumping other information further down Sample page
Adds recommended constructor for RF (nonseparable + low rank) RF page

Also

Updates testing to Julia v1.10, as pkg downloader would not work on 1.7.3 thus we could not merge PRs

[ ] I have read and checked the items on the review checklist.

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (a621a04) 88.09% compared to head (c75ac05) 88.16%. Report is 10 commits behind head on main.

:exclamation: Current head c75ac05 differs from pull request most recent head ee17c5c. Consider uploading reports for the commit ee17c5c to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #271 +/- ## ========================================== + Coverage 88.09% 88.16% +0.07% ========================================== Files 7 7 Lines 1134 1124 -10 ========================================== - Hits 999 991 -8 + Misses 135 133 -2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

odunbar commented 6 months ago

Julia-wide registry issues are causing Buildkite to fail (and this cannot be fixed, whereas I can rerun test suites until they pass), I will bypass the buildkite to merge as we have not changed any of the files being run.