Skip to content
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

📚 New theme & rearrangement of the docs #4835

Merged
merged 67 commits into from
Mar 15, 2021
Merged
Show file tree
Hide file tree
Changes from 58 commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
90ae42a
New theme & rearrangement of the docs
andersy005 Jan 21, 2021
42e3c56
[skip-ci] Skip CI builds
andersy005 Jan 21, 2021
4c0b6a2
[skip-ci] Fix spacing for proper table renderring
andersy005 Jan 21, 2021
ef4e498
Set maxdepth to 2
andersy005 Jan 21, 2021
8cbf52c
[skip-ci] Skip CI builds
andersy005 Jan 21, 2021
893d7e0
[skip-ci] Add "edit this page" button
andersy005 Jan 21, 2021
84e34eb
Merge branch 'master' of github.com:pydata/xarray into docs/new-theme
andersy005 Jan 21, 2021
6cfe8a8
[skip-ci] Skip CI builds
andersy005 Jan 21, 2021
7df46e0
New theme & rearrangement of the docs
andersy005 Jan 21, 2021
4480b96
[skip-ci] Skip CI builds
andersy005 Jan 21, 2021
cbb49c7
[skip-ci] Fix spacing for proper table renderring
andersy005 Jan 21, 2021
84a813f
Set maxdepth to 2
andersy005 Jan 21, 2021
a1ce627
[skip-ci] Skip CI builds
andersy005 Jan 21, 2021
7e44550
[skip-ci] Add "edit this page" button
andersy005 Jan 21, 2021
2d9e2a1
[skip-ci] Skip CI builds
andersy005 Jan 21, 2021
de8fe49
Merge branch 'docs/new-theme' of github.com:andersy005/xarray into do…
andersy005 Feb 1, 2021
8551a67
Merge branch 'master' of github.com:pydata/xarray into docs/new-theme
andersy005 Feb 1, 2021
d82de12
Add examples and ecosystem to main menu
andersy005 Feb 3, 2021
35ebb7d
[skip-ci] Reset TOC maxdepth
andersy005 Feb 3, 2021
1c4dbc4
Fix heading inconsistencies
andersy005 Feb 3, 2021
b2480cb
[skip-ci] Fix dask doc reference
andersy005 Feb 3, 2021
d57a8fe
[skip-ci] New look for examples.rst and roadmap.rst
andersy005 Feb 4, 2021
358997f
examples --> gallery
andersy005 Feb 4, 2021
5176e3e
[skip-ci] create thumbnail folder
andersy005 Feb 4, 2021
6e40a20
[skip-ci] Refactor index.rst
andersy005 Feb 4, 2021
189f64a
[skip-ci] Revert heading changes
andersy005 Feb 4, 2021
694bc06
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Feb 10, 2021
7b2a01d
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Feb 17, 2021
5e15d0b
Declare the extension safe for parallel reads
andersy005 Feb 17, 2021
3232764
[skip-ci] Fix parallel read and write settings
andersy005 Feb 17, 2021
0cff30e
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Feb 20, 2021
de220db
Use sphinx book theme
andersy005 Mar 3, 2021
b403702
Merge branch 'master' of github.com:pydata/xarray into docs/new-theme
andersy005 Mar 3, 2021
abbf6ce
[skip-ci] Use sphinx-book-theme
andersy005 Mar 3, 2021
d12874a
[skip-ci] Revert back to nbsphinx
andersy005 Mar 3, 2021
211b712
Split internals.rst into multiple pages
andersy005 Mar 3, 2021
ece07de
remove reference guide directory
andersy005 Mar 3, 2021
d17df97
[skip-ci] Trigger another build
andersy005 Mar 3, 2021
30be797
[skip-ci] Fix references
andersy005 Mar 3, 2021
135ee66
[skip-ci] First stab at enabling live execution via thebe
andersy005 Mar 3, 2021
3463688
[skip-ci] Disable thebe for the time being
andersy005 Mar 4, 2021
c5a5e27
Update install instructions
andersy005 Mar 4, 2021
b3529fb
Add sphinx copybutton
andersy005 Mar 4, 2021
c21d596
[skip-ci] Add external resources page
andersy005 Mar 4, 2021
fb12ecf
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Mar 4, 2021
5ec298a
[skip-ci] Define redirects for moved pages
andersy005 Mar 4, 2021
b7a4cc7
[skip-ci] Disable redirects for the time being
andersy005 Mar 4, 2021
f4ece77
[skip-ci] Add Team page and update roadmap
andersy005 Mar 4, 2021
0c45e14
[skip-ci] Fix nbsphinx prolog
andersy005 Mar 4, 2021
ae70707
[skip-ci] Attempt at using binder launch button
andersy005 Mar 4, 2021
204bd8a
[skip-ci] Enable nbsphinx prolog
andersy005 Mar 4, 2021
75ed161
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Mar 5, 2021
5d8e155
[skip-ci] related-projects -> ecosystem | external-resources -> tutor…
andersy005 Mar 5, 2021
66e39df
[skip-ci] Remove numpydoc configurations
andersy005 Mar 5, 2021
6ddf2ba
[skip-ci] Fix edit on page button
andersy005 Mar 7, 2021
009648c
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Mar 7, 2021
114eb7a
[skip-ci] Update whats-new
andersy005 Mar 7, 2021
266cd6c
[skip-ci] Revert to original heading
andersy005 Mar 7, 2021
f506538
[skip-ci] Enable redirects via rediraffe ext
andersy005 Mar 7, 2021
b7fa2ef
[skip-ci] Sticky left sidebar
andersy005 Mar 7, 2021
e56b443
[skip-ci] Reduce left and right margins -> more screen estate
andersy005 Mar 9, 2021
85a9dfb
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Mar 9, 2021
0d3e954
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Mar 10, 2021
590ed90
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Mar 12, 2021
44527fb
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Mar 12, 2021
00cc772
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Mar 15, 2021
5128bd7
[skip-ci] Merge branch 'master' of github.com:pydata/xarray into docs…
andersy005 Mar 15, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,11 @@ dask-worker-space/

# xarray specific
doc/_build
doc/generated
generated/
xarray/tests/data/*.grib.*.idx

# Sync tools
Icon*

.ipynb_checkpoints
doc/rasm.zarr
12 changes: 8 additions & 4 deletions ci/requirements/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,20 @@ dependencies:
- numba
- numpy>=1.17
- pandas>=1.0
- pip
- pydata-sphinx-theme>=0.4.3
- rasterio>=1.1
- seaborn
- setuptools
- sparse
- sphinx>=3.3
- sphinx_rtd_theme>=0.4
- sphinx-autosummary-accessors
- sphinx-book-theme >= 0.0.38
- sphinx-copybutton
- sphinx-panels
- sphinx>=3.3
- zarr>=2.4
- pip
- pip:
- scanpydoc
- sphinx-reredirects
- sphinxext-opengraph
# relative to this file. Needs to be editable to be accepted.
- -e ../..
8 changes: 8 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " rtdhtml Build html using same settings used on ReadtheDocs"
@echo " livehtml Make standalone HTML files and rebuild the documentation when a change is detected. Also includes a livereload enabled web server"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
Expand Down Expand Up @@ -58,6 +59,13 @@ html:
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

.PHONY: rtdhtml
rtdhtml:
$(SPHINXBUILD) -T -j auto -E -W --keep-going -b html -d $(BUILDDIR)/doctrees -D language=en . $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."


.PHONY: livehtml
livehtml:
# @echo "$(SPHINXATUOBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html"
Expand Down
Binary file added doc/_static/thumbnails/ERA5-GRIB-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/thumbnails/ROMS_ocean_model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/thumbnails/monthly-means.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/thumbnails/toy-weather-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions doc/_templates/autosummary/base.rst

This file was deleted.

Loading