docs(python): Add IO plugins to Python API reference #21028
Merged
+60
−16
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
henryharbeck
requested review from
ritchie46,
c-peters,
alexander-beedie,
MarcoGorelli and
reswqa
as code owners
github-actions
bot
added
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #21028 +/- ##
==========================================
- Coverage 79.34% 79.17% -0.17%
==========================================
Files 1579 1583 +4
Lines 224319 225222 +903
Branches 2573 2586 +13
==========================================
+ Hits 177976 178315 +339
- Misses 45755 46317 +562
- Partials 588 590 +2 ☔ View full report in Codecov by Sentry. |
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.
Closes #20996
Adds IO plugins to the Python API reference.
Given that plugins are a bit more advanced (like extending the API), I thought it would be useful to provide some extra detail in the API reference too. This text is copied from the user guide.
Few small drive-bys including updating user guide links. Note that these link do not work on the currently deployed user guide, but consider the changes in #20982
Personally I find the reST text a bit hard to envisage, so here are some screenshots of my local deployment of the docs with the changes.
https://github.com/user-attachments/assets/a4668566-1985-475e-aa4b-6586fad5f294
https://github.com/user-attachments/assets/5b434f44-57d1-4f3e-8888-0e10e4a88446
https://github.com/user-attachments/assets/5b46b6e2-f355-4ddc-9e6e-bbf4e1a6201d