Skip to content

Commit fbff4a7

Browse files
committed
Merge pull request #233 from xray/docs-v0.3
Revised documentation in preparation for v0.3
2 parents 2db52f2 + 171e03a commit fbff4a7

30 files changed

+1993
-1414
lines changed

.gitmodules

-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +0,0 @@
1-
[submodule "doc/sphinxext/numpydoc"]
2-
path = doc/sphinxext/numpydoc
3-
url = https://github.com/numpy/numpydoc.git

doc/_static/dataset-diagram.png

1.04 KB
Loading

doc/_static/dataset-diagram.tex

+3-3
Original file line numberDiff line numberDiff line change
@@ -257,13 +257,13 @@
257257
emphstyle=very thick,
258258
}
259259
\node [font=\fontsize{11}{11}\selectfont] at (18,11.5) {temperature};
260-
\node [font=\fontsize{11}{11}\selectfont] at (23,11.5) {pressure};
260+
\node [font=\fontsize{11}{11}\selectfont] at (23,11.5) {precipitation};
261261
\node [font=\fontsize{11}{11}\selectfont] at (25.8,11.5) {latitude};
262262
\node [font=\fontsize{11}{11}\selectfont] at (27.5,11.47) {longitude};
263263
\node [font=\fontsize{11}{11}\selectfont] at (28,10) {x};
264264
\node [font=\fontsize{11}{11}\selectfont] at (29.5,8.5) {y};
265-
\node [font=\fontsize{11}{11}\selectfont] at (32,7) {z};
266-
\node [font=\fontsize{11}{11}\selectfont] at (31,10) {time};
265+
\node [font=\fontsize{11}{11}\selectfont] at (32,7) {t};
266+
\node [font=\fontsize{11}{11}\selectfont] at (31,10) {reference\_time};
267267
\fill (31,9.5) circle[radius=2pt];
268268
\end{tikzpicture}
269269

doc/_static/opendap-prism-tmax.png

-332 Bytes
Loading

doc/api-hidden.rst

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
.. Generate API reference pages, but don't display these in tables.
2+
.. This extra page is a work around for sphinx not having any support for
3+
.. hiding an autosummary table.
4+
5+
.. currentmodule:: xray
6+
7+
.. autosummary::
8+
:toctree: generated/
9+
10+
Dataset.all
11+
Dataset.any
12+
Dataset.argmax
13+
Dataset.argmin
14+
Dataset.max
15+
Dataset.min
16+
Dataset.mean
17+
Dataset.prod
18+
Dataset.sum
19+
Dataset.std
20+
Dataset.var
21+
22+
Dataset.isnull
23+
Dataset.notnull
24+
25+
Dataset.argsort
26+
Dataset.clip
27+
Dataset.conj
28+
Dataset.conjugate
29+
Dataset.round
30+
Dataset.T
31+
32+
DataArray.ndim
33+
DataArray.shape
34+
DataArray.size
35+
DataArray.dtype
36+
DataArray.astype
37+
DataArray.item
38+
39+
DataArray.all
40+
DataArray.any
41+
DataArray.argmax
42+
DataArray.argmin
43+
DataArray.max
44+
DataArray.min
45+
DataArray.mean
46+
DataArray.prod
47+
DataArray.sum
48+
DataArray.std
49+
DataArray.var
50+
51+
DataArray.isnull
52+
DataArray.notnull
53+
54+
DataArray.argsort
55+
DataArray.clip
56+
DataArray.conj
57+
DataArray.conjugate
58+
DataArray.searchsorted
59+
DataArray.round
60+
DataArray.T

0 commit comments

Comments
 (0)