DOCS: replace napolean with numpydoc for the API docs. #5910
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5910 +/- ##
=======================================
Coverage 89.76% 89.77%
=======================================
Files 93 93
Lines 22982 22995 +13
Branches 5006 5011 +5
=======================================
+ Hits 20630 20643 +13
Misses 1622 1622
Partials 730 730 ☔ View full report in Codecov by Sentry. |
github-actions
bot
added
the
benchmark_this
⏱️ Performance Benchmark Report: 38c6a75Performance shiftsFull benchmark resultsGenerated by GHA run |
* upstream/main: Enhance Cube slicing docs (SciTools#5735) Bump scitools/workflows from 2024.04.0 to 2024.04.1 (SciTools#5914) [pre-commit.ci] pre-commit autoupdate (SciTools#5913) Revert "Updated environment lockfiles (SciTools#5911)" (SciTools#5912) Shapefile user guide typos (SciTools#5759) Updated environment lockfiles (SciTools#5911)
⏱️ Performance Benchmark Report: 46ad6cdPerformance shiftsFull benchmark resultsGenerated by GHA run |
⏱️ Performance Benchmark Report: a901752Performance shiftsFull benchmark resultsGenerated by GHA run |
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
WIP. DO NOT REVIEW OR MERGE
Description
Retires napolean in favour of numpydoc. This is more compatible with the numpy docstrings we now use. It also allows us to use nitpicky to check all cross referencing in our docs.
nitpicky is only used when using
make html-nitpicky. This allows us to improve the docs without having to deal with all the warnings in one go.This PR will change how the API Docs look, in particular the layout of the parameters bullet points.
Napolean (old)
numpdoc (new)
Consult Iris pull request check list
Add any of the below labels to trigger actions on this PR: