Make further topics obviously different#5684
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5684 +/- ##
=======================================
Coverage 89.69% 89.69%
=======================================
Files 90 90
Lines 22809 22809
Branches 5441 5441
=======================================
Hits 20458 20458
Misses 1618 1618
Partials 733 733 ☔ View full report in Codecov by Sentry. |
ESadek-MO
left a comment
ESadek-MO
left a comment
There was a problem hiding this comment.
I wonder if we should apply this to all nested toc-members? I found the below all expand out when clicked:
- Dask Best Practices
- Mesh Support
- Gallery
I think we should maintain consistency throughout the docs, which'd also mean we'd have to remember the format if creating new nests later down the line (which is a good habit, just thought it was worth noting).
It's a good idea though, and a simple change!
|
There maybe an option in the pydata theme to do this. I will check. |
There is! I'm just checking the blame for why we turned it off originally... |
@tkknight looks like this line was introduced when you introduced PyData Theme (#4661). Would you be comfortable with me turning it off? Line 294 in 2bfaebd |
|
Try removing this line and rebuild the docs. https://github.com/SciTools/iris/blob/main/docs/src/conf.py#L294 |
|
I like it
|
ESadek-MO
left a comment
ESadek-MO
left a comment
There was a problem hiding this comment.
I really like this new version. Adds a lot of functionality with a single line of code imo, and doesn't seem to break anything.
Just need to add a whatsnew then I'm happy for this to go!
ESadek-MO
left a comment
ESadek-MO
left a comment
There was a problem hiding this comment.
Super happy with this, thanks @trexfeathers!
* upstream/main: 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)
* upstream/main: 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)
* 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) ...
3 participants
🚀 Pull Request
Description
A very simple way to make it obvious in a TOC-tree that
Further Topicsis not just a page, but a subsection of its own.I chose to edit the title itself, rather than an alias in the existing TOC-tree, so that this will also apply if included in other TOC-trees. I also kinda like the title being this way 😁
Consult Iris pull request check list