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.

Sign up for GitHub

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

Jump to bottom

silence sphinx warnings round 3 #3602

Merged
merged 32 commits into from
Dec 17, 2019
Merged

silence sphinx warnings round 3 #3602

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
7ab15e8
fix the deprecated section and update links to drop
keewis Dec 6, 2019
dbc8847
link to interp_like instead of interpolate_like
keewis Dec 6, 2019
7dbacee
update links in the manually written parts of the documentation
keewis Dec 6, 2019
4d9f9e1
add missing methods for DatasetGroupBy, DataArrayGroupBy and Variable
keewis Dec 6, 2019
097d36a
update references in whats-new.rst
keewis Dec 7, 2019
446806d
fix a few mistakes in the reference targets
keewis Dec 7, 2019
0d97b76
Merge branch 'master' into silence-sphinx-warnings-round-3
keewis Dec 9, 2019
e5f1be9
add missing methods for Data*Rolling, Data*GroupBy and Data*Resample
keewis Dec 9, 2019
aaa8628
add all CFTimeIndex methods
keewis Dec 9, 2019
d931eff
fix a few more broken links in whats-new.rst
keewis Dec 10, 2019
02685e0
remove documentation links for some non-public methods / functions
keewis Dec 10, 2019
9ee1745
add missing methods to Data*Coarsen
keewis Dec 10, 2019
397e2b1
move the coarsen objects into their own section in api.rst
keewis Dec 10, 2019
a5c05ca
use currentmodule instead of prefixing with ~xarray
keewis Dec 10, 2019
ab6a3f9
Merge branch 'master' into silence-sphinx-warnings-round-3
keewis Dec 10, 2019
0a5395b
add a new tutorial section
keewis Dec 10, 2019
57e67fd
add show_versions and set_options
keewis Dec 11, 2019
a46d4b3
add FacetGrid to api.rst and update links
keewis Dec 11, 2019
8903264
use plot.line instead of plot.plot
keewis Dec 11, 2019
610710f
add the CFTimeIndex properties to api-hidden.rst
keewis Dec 15, 2019
223d48d
add the backend objects' methods to api-hidden.rst
keewis Dec 15, 2019
47a5504
add missing dict methods to api.rst
keewis Dec 15, 2019
78eda59
add the coordinates objects to api.rst
keewis Dec 15, 2019
78a8d83
add the data store properties to api-hidden.rst
keewis Dec 15, 2019
7fc9291
add IndexVariable methods and properties to api-hidden.rst
keewis Dec 15, 2019
51202bc
add properties for *Coarsen, *GroupBy, *Resample and *Rolling to api-…
keewis Dec 15, 2019
3e13711
add IndexVariable.get_level_variable to api-hidden.rst
keewis Dec 15, 2019
f0893a0
add the accessor methods / properties to api-hidden.rst
keewis Dec 15, 2019
578350e
add the RollingExp method to api-hidden.rst
keewis Dec 15, 2019
65752fd
fix the docstring of StringAccessor.replace
keewis Dec 15, 2019
216fc6c
mention load_store instead of from_store and generate a page for dump…
keewis Dec 17, 2019
c1aacb9
also add load_store
keewis Dec 17, 2019
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
269 changes: 268 additions & 1 deletion doc/api-hidden.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,66 @@
Dataset.std
Dataset.var

core.rolling.DatasetCoarsen
keewis marked this conversation as resolved.
Show resolved Hide resolved

core.groupby.DatasetGroupBy.assign
core.groupby.DatasetGroupBy.assign_coords
core.groupby.DatasetGroupBy.first
core.groupby.DatasetGroupBy.last
core.groupby.DatasetGroupBy.fillna
core.groupby.DatasetGroupBy.quantile
core.groupby.DatasetGroupBy.where
core.groupby.DatasetGroupBy.all
dcherian marked this conversation as resolved.
Show resolved Hide resolved
core.groupby.DatasetGroupBy.any
core.groupby.DatasetGroupBy.argmax
core.groupby.DatasetGroupBy.argmin
core.groupby.DatasetGroupBy.count
core.groupby.DatasetGroupBy.max
core.groupby.DatasetGroupBy.mean
core.groupby.DatasetGroupBy.median
core.groupby.DatasetGroupBy.min
core.groupby.DatasetGroupBy.prod
core.groupby.DatasetGroupBy.std
core.groupby.DatasetGroupBy.sum
core.groupby.DatasetGroupBy.var

core.resample.DatasetResample.all
core.resample.DatasetResample.any
core.resample.DatasetResample.apply
core.resample.DatasetResample.argmax
core.resample.DatasetResample.argmin
core.resample.DatasetResample.assign
core.resample.DatasetResample.assign_coords
core.resample.DatasetResample.bfill
core.resample.DatasetResample.count
core.resample.DatasetResample.ffill
core.resample.DatasetResample.fillna
core.resample.DatasetResample.first
core.resample.DatasetResample.last
core.resample.DatasetResample.map
core.resample.DatasetResample.max
core.resample.DatasetResample.mean
core.resample.DatasetResample.median
core.resample.DatasetResample.min
core.resample.DatasetResample.prod
core.resample.DatasetResample.quantile
core.resample.DatasetResample.reduce
core.resample.DatasetResample.std
core.resample.DatasetResample.sum
core.resample.DatasetResample.var
core.resample.DatasetResample.where

core.rolling.DatasetRolling.argmax
core.rolling.DatasetRolling.argmin
core.rolling.DatasetRolling.count
core.rolling.DatasetRolling.max
core.rolling.DatasetRolling.mean
core.rolling.DatasetRolling.median
core.rolling.DatasetRolling.min
core.rolling.DatasetRolling.prod
core.rolling.DatasetRolling.std
core.rolling.DatasetRolling.sum
core.rolling.DatasetRolling.var

Dataset.argsort
Dataset.astype
Expand Down Expand Up @@ -71,12 +124,64 @@
DataArray.std
DataArray.var

core.rolling.DataArrayCoarsen

core.groupby.DataArrayGroupBy.assign_coords
core.groupby.DataArrayGroupBy.first
core.groupby.DataArrayGroupBy.last
core.groupby.DataArrayGroupBy.fillna
core.groupby.DataArrayGroupBy.quantile
core.groupby.DataArrayGroupBy.where
core.groupby.DataArrayGroupBy.all
core.groupby.DataArrayGroupBy.any
core.groupby.DataArrayGroupBy.argmax
core.groupby.DataArrayGroupBy.argmin
core.groupby.DataArrayGroupBy.count
core.groupby.DataArrayGroupBy.max
core.groupby.DataArrayGroupBy.mean
core.groupby.DataArrayGroupBy.median
core.groupby.DataArrayGroupBy.min
core.groupby.DataArrayGroupBy.prod
core.groupby.DataArrayGroupBy.std
core.groupby.DataArrayGroupBy.sum
core.groupby.DataArrayGroupBy.var

core.resample.DataArrayResample.all
core.resample.DataArrayResample.any
core.resample.DataArrayResample.apply
core.resample.DataArrayResample.argmax
core.resample.DataArrayResample.argmin
core.resample.DataArrayResample.assign_coords
core.resample.DataArrayResample.bfill
core.resample.DataArrayResample.count
core.resample.DataArrayResample.ffill
core.resample.DataArrayResample.fillna
core.resample.DataArrayResample.first
core.resample.DataArrayResample.last
core.resample.DataArrayResample.map
core.resample.DataArrayResample.max
core.resample.DataArrayResample.mean
core.resample.DataArrayResample.median
core.resample.DataArrayResample.min
core.resample.DataArrayResample.prod
core.resample.DataArrayResample.quantile
core.resample.DataArrayResample.reduce
core.resample.DataArrayResample.std
core.resample.DataArrayResample.sum
core.resample.DataArrayResample.var
core.resample.DataArrayResample.where

core.rolling.DataArrayRolling.argmax
core.rolling.DataArrayRolling.argmin
core.rolling.DataArrayRolling.count
core.rolling.DataArrayRolling.max
core.rolling.DataArrayRolling.mean
core.rolling.DataArrayRolling.median
core.rolling.DataArrayRolling.min
core.rolling.DataArrayRolling.prod
core.rolling.DataArrayRolling.std
core.rolling.DataArrayRolling.sum
core.rolling.DataArrayRolling.var

DataArray.argsort
DataArray.clip
Expand All @@ -91,6 +196,80 @@
DataArray.cumprod
DataArray.rank

Variable.all
keewis marked this conversation as resolved.
Show resolved Hide resolved
Variable.any
Variable.argmax
Variable.argmin
Variable.argsort
Variable.astype
Variable.broadcast_equals
Variable.chunk
Variable.clip
Variable.coarsen
Variable.compute
Variable.concat
Variable.conj
Variable.conjugate
Variable.copy
Variable.count
Variable.cumprod
Variable.cumsum
Variable.equals
Variable.fillna
Variable.get_axis_num
Variable.identical
Variable.isel
Variable.isnull
Variable.item
Variable.load
Variable.max
Variable.mean
Variable.median
Variable.min
Variable.no_conflicts
Variable.notnull
Variable.pad_with_fill_value
Variable.prod
Variable.quantile
Variable.rank
Variable.reduce
Variable.roll
Variable.rolling_window
Variable.round
Variable.searchsorted
Variable.set_dims
Variable.shift
Variable.squeeze
Variable.stack
Variable.std
Variable.sum
Variable.to_base_variable
Variable.to_coord
Variable.to_dict
Variable.to_index
Variable.to_index_variable
Variable.to_variable
Variable.transpose
Variable.unstack
Variable.var
Variable.where

Variable.T
Variable.attrs
Variable.chunks
Variable.data
Variable.dims
Variable.dtype
Variable.encoding
Variable.imag
Variable.nbytes
Variable.ndim
Variable.real
Variable.shape
Variable.size
Variable.sizes
Variable.values

ufuncs.angle
ufuncs.arccos
ufuncs.arccosh
Expand Down Expand Up @@ -156,6 +335,94 @@
plot.FacetGrid.set_ticks
plot.FacetGrid.map

CFTimeIndex.all
dcherian marked this conversation as resolved.
Show resolved Hide resolved
CFTimeIndex.any
CFTimeIndex.append
CFTimeIndex.argmax
CFTimeIndex.argmin
CFTimeIndex.argsort
CFTimeIndex.asof
CFTimeIndex.asof_locs
CFTimeIndex.astype
CFTimeIndex.contains
CFTimeIndex.copy
CFTimeIndex.delete
CFTimeIndex.difference
CFTimeIndex.drop
CFTimeIndex.drop_duplicates
CFTimeIndex.droplevel
CFTimeIndex.dropna
CFTimeIndex.duplicated
CFTimeIndex.equals
CFTimeIndex.factorize
CFTimeIndex.fillna
CFTimeIndex.format
CFTimeIndex.get_duplicates
CFTimeIndex.get_indexer
CFTimeIndex.get_indexer_for
CFTimeIndex.get_indexer_non_unique
CFTimeIndex.get_level_values
CFTimeIndex.get_loc
CFTimeIndex.get_slice_bound
CFTimeIndex.get_value
CFTimeIndex.get_values
CFTimeIndex.groupby
CFTimeIndex.holds_integer
CFTimeIndex.identical
CFTimeIndex.insert
CFTimeIndex.intersection
CFTimeIndex.is_
CFTimeIndex.is_boolean
CFTimeIndex.is_categorical
CFTimeIndex.is_floating
CFTimeIndex.is_integer
CFTimeIndex.is_interval
CFTimeIndex.is_lexsorted_for_tuple
CFTimeIndex.is_mixed
CFTimeIndex.is_numeric
CFTimeIndex.is_object
CFTimeIndex.is_type_compatible
CFTimeIndex.isin
CFTimeIndex.isna
CFTimeIndex.isnull
CFTimeIndex.item
CFTimeIndex.join
CFTimeIndex.map
CFTimeIndex.max
CFTimeIndex.memory_usage
CFTimeIndex.min
CFTimeIndex.notna
CFTimeIndex.notnull
CFTimeIndex.nunique
CFTimeIndex.putmask
CFTimeIndex.ravel
CFTimeIndex.reindex
CFTimeIndex.rename
CFTimeIndex.repeat
CFTimeIndex.searchsorted
CFTimeIndex.set_names
CFTimeIndex.set_value
CFTimeIndex.shift
CFTimeIndex.to_datetimeindex
CFTimeIndex.slice_indexer
CFTimeIndex.slice_locs
CFTimeIndex.sort
CFTimeIndex.sort_values
CFTimeIndex.sortlevel
CFTimeIndex.strftime
CFTimeIndex.summary
CFTimeIndex.symmetric_difference
CFTimeIndex.take
CFTimeIndex.to_datetimeindex
CFTimeIndex.to_flat_index
CFTimeIndex.to_frame
CFTimeIndex.to_list
CFTimeIndex.to_native_types
CFTimeIndex.to_numpy
CFTimeIndex.to_series
CFTimeIndex.tolist
CFTimeIndex.transpose
CFTimeIndex.union
CFTimeIndex.unique
CFTimeIndex.value_counts
CFTimeIndex.view
CFTimeIndex.where
3 changes: 3 additions & 0 deletions doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -679,6 +679,9 @@ arguments for the ``from_store`` and ``dump_to_store`` Dataset methods:
Deprecated / Pending Deprecation
================================

.. autosummary::
:toctree: generated/

Dataset.drop
DataArray.drop
Dataset.apply
Expand Down
6 changes: 3 additions & 3 deletions doc/groupby.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Apply
~~~~~

To apply a function to each group, you can use the flexible
:py:meth:`~xarray.DatasetGroupBy.map` method. The resulting objects are automatically
:py:meth:`~xarray.core.groupby.DatasetGroupBy.map` method. The resulting objects are automatically
concatenated back together along the group axis:

.. ipython:: python
Expand All @@ -104,8 +104,8 @@ concatenated back together along the group axis:

arr.groupby('letters').map(standardize)

GroupBy objects also have a :py:meth:`~xarray.DatasetGroupBy.reduce` method and
methods like :py:meth:`~xarray.DatasetGroupBy.mean` as shortcuts for applying an
GroupBy objects also have a :py:meth:`~xarray.core.groupby.DatasetGroupBy.reduce` method and
methods like :py:meth:`~xarray.core.groupby.DatasetGroupBy.mean` as shortcuts for applying an
aggregation function:

.. ipython:: python
Expand Down
4 changes: 2 additions & 2 deletions doc/howdoi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ How do I ...
* - change the order of dimensions
- :py:meth:`DataArray.transpose`, :py:meth:`Dataset.transpose`
* - remove a variable from my object
- :py:meth:`Dataset.drop`, :py:meth:`DataArray.drop`
- :py:meth:`Dataset.drop_vars`, :py:meth:`DataArray.drop_vars`
* - remove dimensions of length 1 or 0
- :py:meth:`DataArray.squeeze`, :py:meth:`Dataset.squeeze`
* - remove all variables with a particular dimension
Expand All @@ -48,7 +48,7 @@ How do I ...
* - write xarray objects with complex values to a netCDF file
- :py:func:`Dataset.to_netcdf`, :py:func:`DataArray.to_netcdf` specifying ``engine="h5netcdf", invalid_netcdf=True``
* - make xarray objects look like other xarray objects
- :py:func:`~xarray.ones_like`, :py:func:`~xarray.zeros_like`, :py:func:`~xarray.full_like`, :py:meth:`Dataset.reindex_like`, :py:meth:`Dataset.interpolate_like`, :py:meth:`Dataset.broadcast_like`, :py:meth:`DataArray.reindex_like`, :py:meth:`DataArray.interpolate_like`, :py:meth:`DataArray.broadcast_like`
- :py:func:`~xarray.ones_like`, :py:func:`~xarray.zeros_like`, :py:func:`~xarray.full_like`, :py:meth:`Dataset.reindex_like`, :py:meth:`Dataset.interp_like`, :py:meth:`Dataset.broadcast_like`, :py:meth:`DataArray.reindex_like`, :py:meth:`DataArray.interp_like`, :py:meth:`DataArray.broadcast_like`
* - replace NaNs with other values
- :py:meth:`Dataset.fillna`, :py:meth:`Dataset.ffill`, :py:meth:`Dataset.bfill`, :py:meth:`Dataset.interpolate_na`, :py:meth:`DataArray.fillna`, :py:meth:`DataArray.ffill`, :py:meth:`DataArray.bfill`, :py:meth:`DataArray.interpolate_na`
* - extract the year, month, day or similar from a DataArray of time values
Expand Down
2 changes: 1 addition & 1 deletion doc/indexing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ use them explicitly to slice data. There are two ways to do this:

The arguments to these methods can be any objects that could index the array
along the dimension given by the keyword, e.g., labels for an individual value,
Python :py:func:`slice` objects or 1-dimensional arrays.
Python :py:class:`slice` objects or 1-dimensional arrays.

.. note::

Expand Down
4 changes: 2 additions & 2 deletions doc/interpolation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ array-like, which gives the interpolated result as an array.
# interpolation
da.interp(time=[2.5, 3.5])

To interpolate data with a :py:func:`numpy.datetime64` coordinate you can pass a string.
To interpolate data with a :py:doc:`numpy.datetime64 <reference/arrays.datetime>` coordinate you can pass a string.

.. ipython:: python

Expand Down Expand Up @@ -128,7 +128,7 @@ It is now possible to safely compute the difference ``other - interpolated``.
Interpolation methods
---------------------

We use :py:func:`scipy.interpolate.interp1d` for 1-dimensional interpolation and
We use :py:class:`scipy.interpolate.interp1d` for 1-dimensional interpolation and
keewis marked this conversation as resolved.
Show resolved Hide resolved
:py:func:`scipy.interpolate.interpn` for multi-dimensional interpolation.

The interpolation method can be specified by the optional ``method`` argument.
Expand Down
Loading