-
Notifications
You must be signed in to change notification settings - Fork 284
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
DOCS: Adopt sphinx-autoapi #6102
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #6102 +/- ##
==========================================
+ Coverage 89.77% 89.86% +0.08%
==========================================
Files 88 88
Lines 23026 23205 +179
Branches 5036 5035 -1
==========================================
+ Hits 20672 20853 +181
+ Misses 1623 1621 -2
Partials 731 731 ☔ View full report in Codecov by Sentry. |
* upstream/main: Restore latest Whats New files. Whats new updates for v3.10.0rc0 . (SciTools#6101) Add mesh metas to the iris.common.metadata public API. (SciTools#6093) Update cf_table v85 (SciTools#6100) Bump scitools/workflows from 2024.07.5 to 2024.07.6 (SciTools#6099)
⏱️ Performance Benchmark Report: b87ba40Performance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: a90451aPerformance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: 846ea2aPerformance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: c28a992Performance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: de2e4e5Performance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: 00eab7cPerformance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: 97ccc76Performance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: 0a0f970Performance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: 6c710e7Performance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: bedfe4dPerformance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: e722830Performance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: f323371Performance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: 1f5e8d0Performance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: a7ca2ccPerformance shifts
Full benchmark results
Generated by GHA run |
* upstream/main: remove --force option as it is not present in conda (only mamba) (SciTools#6111) fix typo for class reference (SciTools#6106) Bump scitools/workflows from 2024.07.6 to 2024.08.0 (SciTools#6105)
⏱️ Performance Benchmark Report: c2299f1Performance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: 7cbf001Performance shifts
Full benchmark results
Generated by GHA run |
⏱️ Performance Benchmark Report: e75935ePerformance shifts
Full benchmark results
Generated by GHA run |
🚀 Pull Request
DRAFT - NOT TO BE REVIEWED YET
Description
Adoption of
sphinx-autoapi
over the default of autodoc.Solves #5708.
sphinx-autoapi
(>=3.0.0)#:
. Instead use triple quotes proceeding the attribute.#:
to use triple quoteautolog
inconf.py
to be more useful (and use colour). Copied from GeoVista.show_toc_level
to be3
inconfig.py
. (page contents - shown on right of the docs)docs/src/sphinxext/api_rst_formatting.py
Consult Iris pull request check list
Add any of the below labels to trigger actions on this PR: