Skip to content

Commit

Permalink
Revised documentation in preparation for v0.3
Browse files Browse the repository at this point in the history
The "tutorial" has been split out into a number of separate chapters.
This should significantly enhance readability and findability.
  • Loading branch information
shoyer committed Sep 17, 2014
1 parent 2db52f2 commit 171e03a
Show file tree
Hide file tree
Showing 30 changed files with 1,993 additions and 1,414 deletions.
3 changes: 0 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
[submodule "doc/sphinxext/numpydoc"]
path = doc/sphinxext/numpydoc
url = https://github.com/numpy/numpydoc.git
Binary file modified doc/_static/dataset-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions doc/_static/dataset-diagram.tex
Original file line number Diff line number Diff line change
Expand Up @@ -257,13 +257,13 @@
emphstyle=very thick,
}
\node [font=\fontsize{11}{11}\selectfont] at (18,11.5) {temperature};
\node [font=\fontsize{11}{11}\selectfont] at (23,11.5) {pressure};
\node [font=\fontsize{11}{11}\selectfont] at (23,11.5) {precipitation};
\node [font=\fontsize{11}{11}\selectfont] at (25.8,11.5) {latitude};
\node [font=\fontsize{11}{11}\selectfont] at (27.5,11.47) {longitude};
\node [font=\fontsize{11}{11}\selectfont] at (28,10) {x};
\node [font=\fontsize{11}{11}\selectfont] at (29.5,8.5) {y};
\node [font=\fontsize{11}{11}\selectfont] at (32,7) {z};
\node [font=\fontsize{11}{11}\selectfont] at (31,10) {time};
\node [font=\fontsize{11}{11}\selectfont] at (32,7) {t};
\node [font=\fontsize{11}{11}\selectfont] at (31,10) {reference\_time};
\fill (31,9.5) circle[radius=2pt];
\end{tikzpicture}

Expand Down
Binary file modified doc/_static/opendap-prism-tmax.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 60 additions & 0 deletions doc/api-hidden.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
.. Generate API reference pages, but don't display these in tables.
.. This extra page is a work around for sphinx not having any support for
.. hiding an autosummary table.
.. currentmodule:: xray

.. autosummary::
:toctree: generated/

Dataset.all
Dataset.any
Dataset.argmax
Dataset.argmin
Dataset.max
Dataset.min
Dataset.mean
Dataset.prod
Dataset.sum
Dataset.std
Dataset.var

Dataset.isnull
Dataset.notnull

Dataset.argsort
Dataset.clip
Dataset.conj
Dataset.conjugate
Dataset.round
Dataset.T

DataArray.ndim
DataArray.shape
DataArray.size
DataArray.dtype
DataArray.astype
DataArray.item

DataArray.all
DataArray.any
DataArray.argmax
DataArray.argmin
DataArray.max
DataArray.min
DataArray.mean
DataArray.prod
DataArray.sum
DataArray.std
DataArray.var

DataArray.isnull
DataArray.notnull

DataArray.argsort
DataArray.clip
DataArray.conj
DataArray.conjugate
DataArray.searchsorted
DataArray.round
DataArray.T
Loading

0 comments on commit 171e03a

Please sign in to comment.