DOCS: API docs ToC more levels #5714
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* upstream/main: (26 commits) Bump scitools/workflows from 2023.12.1 to 2024.01.0 (SciTools#5710) Faster trivial equality checks for coordinates and arrays (SciTools#5691) Make the Coord.cell method lazy (SciTools#5693) Re-write `pearsonr` to use `Resolve` (SciTools#5638) ruff compliance for D401. (SciTools#5687) Bump actions/cache from 3 to 4 (SciTools#5703) update rtd ubuntu and mambaforge (SciTools#5702) [pre-commit.ci] pre-commit autoupdate (SciTools#5699) ruff compliance for D205. (SciTools#5681) Added whatsnew to warnings PR (SciTools#5696) Removed use of catch_warnings (SciTools#5685) Better documentation for Cube names in curl (SciTools#5680) fix typo (SciTools#5689) Make further topics obviously different (SciTools#5684) [pre-commit.ci] pre-commit autoupdate (SciTools#5682) ruff complliance for D100. (SciTools#5678) move tests.pp to tests.__init__ (SciTools#5679) ruff compliance for D417, D106 (SciTools#5677) ruff compliance for D200. (SciTools#5675) ruff compliance for D106. (SciTools#5676) ...
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5714 +/- ##
=======================================
Coverage 89.71% 89.71%
=======================================
Files 90 90
Lines 22815 22815
Branches 5438 5438
=======================================
Hits 20468 20468
Misses 1617 1617
Partials 730 730 ☔ View full report in Codecov by Sentry. |
|
@tkknight are you still hoping to have team eyes on this before it gets merged? |
I think that will be useful. |
|
@SciTools/peloton unanimously agrees! |
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Feb 3, 2024
* upstream/main: DOCS: API docs ToC more levels (SciTools#5714) Bump scitools/workflows from 2024.01.0 to 2024.02.0 (SciTools#5726)
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Feb 5, 2024
* upstream/main: Bump codecov/codecov-action from 3 to 4 (SciTools#5727) DOCS: API docs ToC more levels (SciTools#5714) Bump scitools/workflows from 2024.01.0 to 2024.02.0 (SciTools#5726) DOCS: numpydocs 8 (SciTools#5722) DOCS: numpydocs 7 (SciTools#5720) DOCS: numpydocs 6 (SciTools#5718) fix docstring types and remove duplicate line. (SciTools#5719)
acchamber
added a commit
to acchamber/iris
that referenced
this pull request
Feb 6, 2024
…into shapefile_masking * 'shapefile_masking' of https://github.com/acchamber/iris: (102 commits) [pre-commit.ci] auto fixes from pre-commit.com hooks Update lib/iris/_shapefiles.py [pre-commit.ci] auto fixes from pre-commit.com hooks Numpydocs misc (SciTools#5728) Updated environment lockfiles (SciTools#5731) Bump codecov/codecov-action from 3 to 4 (SciTools#5727) DOCS: API docs ToC more levels (SciTools#5714) Bump scitools/workflows from 2024.01.0 to 2024.02.0 (SciTools#5726) DOCS: numpydocs 8 (SciTools#5722) DOCS: numpydocs 7 (SciTools#5720) DOCS: numpydocs 6 (SciTools#5718) fix docstring types and remove duplicate line. (SciTools#5719) Updated environment lockfiles (SciTools#5717) numpydocs (SciTools#5715) DOCS: numpydocs 4 (SciTools#5711) DOCS: Add ruff section to the dev guide docs (SciTools#5701) [pre-commit.ci] pre-commit autoupdate (SciTools#5709) Bump scitools/workflows from 2023.12.1 to 2024.01.0 (SciTools#5710) Faster trivial equality checks for coordinates and arrays (SciTools#5691) Make the Coord.cell method lazy (SciTools#5693) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🚀 Pull Request
Description
Increases from 1 to 2 for the level of table of contents in the right hand sidebar. This makes a significant different when browsing the API Documentation.
Some examples:
Note that some ToCs (right side) are really useful, but some can be long with a vertical and horizontal scroll (see iris.exceptions link above).
I believe the benefits in the navigation outweigh any scrollbars being present. This PR may need some visibility to more than just a single reviewer. Perhaps a short discussion in a @SciTools/peloton .
Consult Iris pull request check list