-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
split out large docs pages: Plotting, Reading and Writing Files #10526
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
for more information, see https://pre-commit.ci
@dcherian The split looks to be good but has an error related to 3D plotting. I am not sure about the error, can you please once check and let me know, what needs to be fixed? |
Add environment variables to disable color output in ReadTheDocs builds: - NO_COLOR=1: Standard environment variable to disable color output - TERM=dumb: Sets terminal type to disable color features - FORCE_COLOR=0: Explicitly disables color output for supporting tools 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- export TERM=dumb | ||
- export FORCE_COLOR=0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure why is this needed?
@@ -155,23 +152,12 @@ this convention when plotting on a map: | |||
ax.coastlines() | |||
ax.gridlines(draw_labels=True); | |||
|
|||
You can however decide to infer the cell boundaries and use the | |||
``infer_intervals`` keyword: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I ripped this out because the narrative no longer corresponds to what the figures show. Would have to spend more time tracking down what changed. But a quick look at previous docs versions show the original behavior changed since https://docs.xarray.dev/en/v0.16.0/plotting.html#multidimensional-coordinates
Also, it's worth considering just moving remaining examples on this index page to different subpages
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good thanks @dhruvak001 ! I did a bit of cleanup and also created a dedicated plotting-maps.rst. preview: https://xray--10526.org.readthedocs.build/en/10526/user-guide/plotting.html
I'm thinking the "Complex Numbers" section under I/O is a bit odd. It could be broken out as subsections in computation and under NetCDF. Thoughts @dcherian?
whats-new.rst
api.rst
Changes:
Reading and Writing Files (io.rst) split into:
io-netcdf-hdf.rst - netCDF and HDF5 formats
io-zarr.rst - Zarr format
io-other-formats.rst - All other formats (pickle, CSV, GRIB, etc.)
Plotting (plotting.rst) split into:
plotting-lines.rst - 1D/Line plots
plotting-2d.rst - 2D plots (pcolormesh, contour, imshow)
plotting-faceting.rst - Faceting and subplots
plotting-scatter-quiver.rst - Scatter, Quiver, and Streamplot
Both original pages now serve as navigation hubs with toctree structures