Adopt sphinx design #5127
Merged
Adopt sphinx design #5127
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: pip pin for sphinx<5 (SciTools#5122)
|
A fix (executablebooks/sphinx-design#109) is needed for sphinx-design to make the presentation of the cards on the Iris docs homepage. Let's sees if it can be fixed before Iris 3.5 due ~April 2023. The alternative is some custom css or making all icon images pngs which I would like to avoid. |
* upstream/main: (59 commits) Updated environment lockfiles (SciTools#5211) update ci locks location (SciTools#5228) Fixes to _discontiguity_in_bounds (attempt 2) (SciTools#4975) Finalises Lazy Data documentation (SciTools#5137) Modernize and simplify iris.analysis._Groupby (SciTools#5015) clarity on whatsnew entry contributors (SciTools#5240) Handle derived coordinates correctly in `concatenate` (SciTools#5096) Use real array for data of of small netCDF variables. (SciTools#5229) Bump scitools/workflows from 2023.04.1 to 2023.04.2 (SciTools#5236) fixing whatsnew entry remove results creation commit from blame configure codecov adding a whatsnew entry Replacing numpy legacy printing with array2string and remaking results for dependent tests Adding a whatsnew entry for 5224 (SciTools#5234) Cf cell method (SciTools#5224) Bump scitools/workflows from 2023.03.3 to 2023.04.1 (SciTools#5231) [pre-commit.ci] pre-commit autoupdate (SciTools#5230) Bump scitools/workflows from 2023.03.2 to 2023.03.3 (SciTools#5227) raise dask min pin (SciTools#5225) ...
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #5127 +/- ##
=======================================
Coverage 89.31% 89.31%
=======================================
Files 88 88
Lines 22279 22279
Branches 4881 4881
=======================================
Hits 19898 19898
Misses 1635 1635
Partials 746 746 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
* upstream/main: libnetcdf <4.9 pin (SciTools#5242) update cf standard units (SciTools#5244)
* upstream/main: Updated environment lockfiles (SciTools#5250)
bjlittle
reviewed
Apr 18, 2023
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Apr 18, 2023
* upstream/main: review actions update .git-blame-ignore-revs adopt codespell Adopt sphinx design (SciTools#5127) Bump scitools/workflows from 2023.04.2 to 2023.04.3 (SciTools#5253)
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Apr 18, 2023
* upstream/main: (29 commits) review actions update .git-blame-ignore-revs adopt codespell Adopt sphinx design (SciTools#5127) Bump scitools/workflows from 2023.04.2 to 2023.04.3 (SciTools#5253) refresh manual pypi publish instructions (SciTools#5252) Updated environment lockfiles (SciTools#5250) removed bugfix section Make bm_runner location agnostic and include debugging. (SciTools#5247) Restore latest Whats New files. SciTools#5220 typo github.repository_owner. (SciTools#5248) Whats new updates for v3.5.0rc0. (SciTools#5246) libnetcdf <4.9 pin (SciTools#5242) update cf standard units (SciTools#5244) Updated environment lockfiles (SciTools#5211) update ci locks location (SciTools#5228) Fixes to _discontiguity_in_bounds (attempt 2) (SciTools#4975) Finalises Lazy Data documentation (SciTools#5137) Modernize and simplify iris.analysis._Groupby (SciTools#5015) clarity on whatsnew entry contributors (SciTools#5240) ...
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Apr 22, 2023
* upstream/main: (61 commits) Updated environment lockfiles (SciTools#5270) Drop python3.8 support (SciTools#5269) build wheel from sdist, not src (SciTools#5266) Lazy netcdf saves (SciTools#5191) move setup.cfg to pyproject.toml (SciTools#5262) Support Python 3.11 (SciTools#5226) Remove Resolve test workaround (SciTools#5267) add missing whatsnew entry (SciTools#5265) make help (SciTools#5258) automate pypi manifest checking (SciTools#5259) drop sphinxcontrib-napoleon (SciTools#5263) add missing test result data (SciTools#5260) fix indentation and remove ref to ssstack (SciTools#5256) review actions update .git-blame-ignore-revs adopt codespell Adopt sphinx design (SciTools#5127) Bump scitools/workflows from 2023.04.2 to 2023.04.3 (SciTools#5253) refresh manual pypi publish instructions (SciTools#5252) Updated environment lockfiles (SciTools#5250) ...
Merged
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
sphinx-panels was being used in the Iris docs for the cards, pulldowns and some icons.
sphinx-panels is now not maintained, instead the developer has moved to sphinx-design.
This PR migrates the Iris docs from sphinx-panels to sphinx-design.
Changes:
dropdown directive syntax changed
updated past whatsnew pages that uses dropdown to use coloured icons
sphinx v5.3 is now used as it was previously pinned to v4.5 by sphinx-panels.
pinned to v5.3 for now as readthedocs jumps to v6.1.3 even though when a conda env is build locally it only uses v5.3. Also the v6.1.3 build docs does not seem to render the Voted Issue List table at all - for now lets pin at v5.3 and review later.
sphinx now seems to create the bookmarks on the API pages correctly, so you can jump to functions using the sidebar, nice.
Removed
sphinxext/custom_class_autodoc.pyas it is no longer needed (and sphinx complains about it now)Used newer syntax for extlinks on
conf.pyCloses #5121
Consult Iris pull request check list