-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Switch doc examples to use nbsphinx #3105
Switch doc examples to use nbsphinx #3105
Conversation
Is there a way we can tell azure not to run all the other test environments for docs-only PRs? That would really speed things up tomorrow. |
Codecov Report
@@ Coverage Diff @@
## scipy19-docs #3105 +/- ##
=============================================
Coverage 95.99% 95.99%
=============================================
Files 63 63
Lines 12796 12796
=============================================
Hits 12284 12284
Misses 512 512 |
I do not understand the coverage report at all. I am seeing huge coverage diffs for files I have not touched. Is this something I need to worry about? |
Doc build succeeded so I'm going to merge to scipy19-docs. |
* switching out examples to use nbsphinx * added jupyter_client to doc env * added ipykernel to doc env
* Switch doc examples to use nbsphinx (#3105) * switching out examples to use nbsphinx * added jupyter_client to doc env * added ipykernel to doc env * Replace sphinx_gallery with notebook (#3106) * switching out examples to use nbsphinx * added jupyter_client to doc env * moved gallery to notebook * Allow other tutorial filename extensions (#3121) * switching out examples to use nbsphinx * added jupyter_client to doc env * allow non netcdf tutorial files * Added ROMS ocean model example notebook (#3116) * change name of test env to xarray-tests (#3110) * ROMS_ocean_model example added * Allow other tutorial filename extensions (#3121) * switching out examples to use nbsphinx * added jupyter_client to doc env * allow non netcdf tutorial files * Changed load to xr.tutorial.open_dataset(), and added some extra documentation. * change name of test env to xarray-tests (#3110) * ROMS_ocean_model example added * Changed load to xr.tutorial.open_dataset(), and added some extra documentation. * fixed colormap issues leftover from cmocean import * Added intro paragraph to ROMS example notebook, removed comments, and added citation in whats-new. * Add an example of ERA5 and GRIB data & visualization to the gallery (#3199) * Adds an example of ERA5 and GRIB data to the gallery * Add markdown narrative cells to GRIB example * Update load method to use xr.tutorial * Fix load method * require nbsphinx for the documentation builds * add more nbsphinx dependencies * install cfgrib using pip * add the eccodes library to the dependencies * remove the dependency on sphinx-gallery * add the ERA5 GRIB example to the list * update the documentation links Missing: section links in visualization_gallery.ipynb don't work yet, also the one in io.rst (it has a unicode char). * Fix leap year condition in monthly means example (#3464) * Typo correction in docs (#3387) * Update terminology.rst (#3455) Fixed broken link * Error in leap year? I've tried this script; however, it adds +1 to all months of the leap years. It sounds like an error, or I am wrong? So I wrote the condition "and month == 2" line 86 so that only the month of February gets +1. * Fix leap year (#3464) * Update doc/whats-new.rst Co-Authored-By: Deepak Cherian <dcherian@users.noreply.github.com> * fix the reference to the rasterio geocoordinates docs * update whats-new.rst
This is the beginning of the docs refactor we have in mind for the sprint tomorrow.
We will merge things first to the scipy19-docs branch so we can make sure things build on RTD.
http://xarray.pydata.org/en/scipy19-docs