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 #3516

Merged
merged 26 commits into from
Nov 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
c9b53bd
silence sphinx warnings
keewis Nov 12, 2019
5d9d263
silence more sphinx warnings
keewis Nov 12, 2019
fb559c0
fix some references
keewis Nov 12, 2019
192eebd
fix the docstrings of Dataset reduce methods
keewis Nov 12, 2019
4b93534
mark the orphaned files as such
keewis Nov 13, 2019
9b24219
silence some nit-picky warnings
keewis Nov 14, 2019
65fc7c3
Merge branch 'master' into silence-sphinx-warnings
dcherian Nov 15, 2019
e452482
Merge branch 'master' into silence-sphinx-warnings
keewis Nov 17, 2019
939c60d
convert all references to xray to double backtick quoted text
keewis Nov 17, 2019
1170910
silence more warnings in whats-new.rst
keewis Nov 17, 2019
4f8d0f1
require a whatsnew format of Name <https://github.com/user>
keewis Nov 17, 2019
7c4211e
rename the second cf conventions link
keewis Nov 17, 2019
cee59e6
silence more sphinx warnings
keewis Nov 17, 2019
562567b
get interpolate_na docstrings in sync with master
keewis Nov 18, 2019
6e223ea
fix sphinx warnings for interpolate_na docstrings
keewis Nov 18, 2019
c8559e4
update references to old documentation sections
keewis Nov 18, 2019
f2cf661
cut the link to h5netcdf.File
keewis Nov 18, 2019
58d243f
use the correct reference types for numpy
keewis Nov 18, 2019
0112190
update the reference to atop (dask renamed it to blockwise)
keewis Nov 18, 2019
935f68c
rewrite numpy docstrings
keewis Nov 18, 2019
c61d19b
guard against non-str documentation
keewis Nov 18, 2019
bdc8594
pass name to skip_signature
keewis Nov 18, 2019
a6453d2
remove links to pandas.Panel
keewis Nov 18, 2019
a220c7a
convince sphinx to create pages astype and groupby().quantile
keewis Nov 18, 2019
17fe69d
more warnings
keewis Nov 19, 2019
20dbc51
Merge branch 'master' into silence-sphinx-warnings
dcherian Nov 19, 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
2 changes: 2 additions & 0 deletions doc/README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

xarray
------

Expand Down
5 changes: 5 additions & 0 deletions doc/api-hidden.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
.. This extra page is a work around for sphinx not having any support for
.. hiding an autosummary table.

:orphan:

.. currentmodule:: xarray

.. autosummary::
Expand Down Expand Up @@ -30,9 +32,11 @@
core.groupby.DatasetGroupBy.first
core.groupby.DatasetGroupBy.last
core.groupby.DatasetGroupBy.fillna
core.groupby.DatasetGroupBy.quantile
core.groupby.DatasetGroupBy.where

Dataset.argsort
Dataset.astype
Dataset.clip
Dataset.conj
Dataset.conjugate
Expand Down Expand Up @@ -71,6 +75,7 @@
core.groupby.DataArrayGroupBy.first
core.groupby.DataArrayGroupBy.last
core.groupby.DataArrayGroupBy.fillna
core.groupby.DataArrayGroupBy.quantile
core.groupby.DataArrayGroupBy.where

DataArray.argsort
Expand Down
6 changes: 3 additions & 3 deletions doc/combining.rst
Original file line number Diff line number Diff line change
Expand Up @@ -255,11 +255,11 @@ Combining along multiple dimensions
``combine_nested``.

For combining many objects along multiple dimensions xarray provides
:py:func:`~xarray.combine_nested`` and :py:func:`~xarray.combine_by_coords`. These
:py:func:`~xarray.combine_nested` and :py:func:`~xarray.combine_by_coords`. These
functions use a combination of ``concat`` and ``merge`` across different
variables to combine many objects into one.

:py:func:`~xarray.combine_nested`` requires specifying the order in which the
:py:func:`~xarray.combine_nested` requires specifying the order in which the
objects should be combined, while :py:func:`~xarray.combine_by_coords` attempts to
infer this ordering automatically from the coordinates in the data.

Expand Down Expand Up @@ -310,4 +310,4 @@ These functions can be used by :py:func:`~xarray.open_mfdataset` to open many
files as one dataset. The particular function used is specified by setting the
argument ``'combine'`` to ``'by_coords'`` or ``'nested'``. This is useful for
situations where your data is split across many files in multiple locations,
which have some known relationship between one another.
which have some known relationship between one another.
6 changes: 3 additions & 3 deletions doc/computation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -325,8 +325,8 @@ Broadcasting by dimension name
``DataArray`` objects are automatically align themselves ("broadcasting" in
the numpy parlance) by dimension name instead of axis order. With xarray, you
do not need to transpose arrays or insert dimensions of length 1 to get array
operations to work, as commonly done in numpy with :py:func:`np.reshape` or
:py:const:`np.newaxis`.
operations to work, as commonly done in numpy with :py:func:`numpy.reshape` or
:py:data:`numpy.newaxis`.

This is best illustrated by a few examples. Consider two one-dimensional
arrays with different sizes aligned along different dimensions:
Expand Down Expand Up @@ -566,7 +566,7 @@ to set ``axis=-1``. As an example, here is how we would wrap

Because ``apply_ufunc`` follows a standard convention for ufuncs, it plays
nicely with tools for building vectorized functions, like
:func:`numpy.broadcast_arrays` and :func:`numpy.vectorize`. For high performance
:py:func:`numpy.broadcast_arrays` and :py:class:`numpy.vectorize`. For high performance
needs, consider using Numba's :doc:`vectorize and guvectorize <numba:user/vectorize>`.

In addition to wrapping functions, ``apply_ufunc`` can automatically parallelize
Expand Down
2 changes: 1 addition & 1 deletion doc/dask.rst
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ automate `embarrassingly parallel
<https://en.wikipedia.org/wiki/Embarrassingly_parallel>`__ "map" type operations
where a function written for processing NumPy arrays should be repeatedly
applied to xarray objects containing Dask arrays. It works similarly to
:py:func:`dask.array.map_blocks` and :py:func:`dask.array.atop`, but without
:py:func:`dask.array.map_blocks` and :py:func:`dask.array.blockwise`, but without
requiring an intermediate layer of abstraction.

For the best performance when using Dask's multi-threaded scheduler, wrap a
Expand Down
6 changes: 3 additions & 3 deletions doc/data-structures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Creating a DataArray
The :py:class:`~xarray.DataArray` constructor takes:

- ``data``: a multi-dimensional array of values (e.g., a numpy ndarray,
:py:class:`~pandas.Series`, :py:class:`~pandas.DataFrame` or :py:class:`~pandas.Panel`)
:py:class:`~pandas.Series`, :py:class:`~pandas.DataFrame` or ``pandas.Panel``)
- ``coords``: a list or dictionary of coordinates. If a list, it should be a
list of tuples where the first element is the dimension name and the second
element is the corresponding coordinate array_like object.
Expand Down Expand Up @@ -125,7 +125,7 @@ As a dictionary with coords across multiple dimensions:

If you create a ``DataArray`` by supplying a pandas
:py:class:`~pandas.Series`, :py:class:`~pandas.DataFrame` or
:py:class:`~pandas.Panel`, any non-specified arguments in the
``pandas.Panel``, any non-specified arguments in the
``DataArray`` constructor will be filled in from the pandas object:

.. ipython:: python
Expand Down Expand Up @@ -301,7 +301,7 @@ names, and its data is aligned to any existing dimensions.

You can also create an dataset from:

- A :py:class:`pandas.DataFrame` or :py:class:`pandas.Panel` along its columns and items
- A :py:class:`pandas.DataFrame` or ``pandas.Panel`` along its columns and items
respectively, by passing it into the :py:class:`~xarray.Dataset` directly
- A :py:class:`pandas.DataFrame` with :py:meth:`Dataset.from_dataframe <xarray.Dataset.from_dataframe>`,
which will additionally handle MultiIndexes See :ref:`pandas`
Expand Down
2 changes: 1 addition & 1 deletion doc/pandas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ automatically stacking them into a ``MultiIndex``.
:py:meth:`DataArray.to_pandas() <xarray.DataArray.to_pandas>` is a shortcut that
lets you convert a DataArray directly into a pandas object with the same
dimensionality (i.e., a 1D array is converted to a :py:class:`~pandas.Series`,
2D to :py:class:`~pandas.DataFrame` and 3D to :py:class:`~pandas.Panel`):
2D to :py:class:`~pandas.DataFrame` and 3D to ``pandas.Panel``):

.. ipython:: python

Expand Down
Loading