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

silence sphinx warnings round 3 #3602

Merged
merged 32 commits into from
Dec 17, 2019
Merged
Show file tree
Hide file tree
Changes from all 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
653 changes: 652 additions & 1 deletion doc/api-hidden.rst

Large diffs are not rendered by default.

37 changes: 36 additions & 1 deletion doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Top-level functions
ones_like
dot
map_blocks
show_versions
set_options

Dataset
=======
Expand Down Expand Up @@ -74,7 +76,9 @@ and values given by ``DataArray`` objects.
Dataset.__setitem__
Dataset.__delitem__
Dataset.update
Dataset.get
Dataset.items
Dataset.keys
Dataset.values

Dataset contents
Expand Down Expand Up @@ -537,6 +541,15 @@ DataArray methods
DataArray.unify_chunks
DataArray.map_blocks

Coordinates objects
===================

.. autosummary::
:toctree: generated/

core.coordinates.DataArrayCoordinates
core.coordinates.DatasetCoordinates

GroupBy objects
===============

Expand Down Expand Up @@ -564,6 +577,16 @@ Rolling objects
core.rolling.DatasetRolling.reduce
core.rolling_exp.RollingExp

Coarsen objects
===============

.. autosummary::
:toctree: generated/

core.rolling.DataArrayCoarsen
core.rolling.DatasetCoarsen


Resample objects
================

Expand Down Expand Up @@ -625,6 +648,7 @@ Plotting
plot.imshow
plot.line
plot.pcolormesh
plot.FacetGrid

Faceting
--------
Expand All @@ -644,6 +668,14 @@ Faceting
plot.FacetGrid.set_xlabels
plot.FacetGrid.set_ylabels

Tutorial
========

.. autosummary::
:toctree: generated/

tutorial.open_dataset
tutorial.load_dataset

Testing
=======
Expand Down Expand Up @@ -681,7 +713,7 @@ Advanced API

These backends provide a low-level interface for lazily loading data from
external file-formats or protocols, and can be manually invoked to create
arguments for the ``from_store`` and ``dump_to_store`` Dataset methods:
arguments for the ``load_store`` and ``dump_to_store`` Dataset methods:

.. autosummary::
:toctree: generated/
Expand All @@ -697,6 +729,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
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
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
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
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