Better links in whats-new

Author: dcherian

doc/api.rst

@@ -10,19 +10,20 @@ DataArray
    :toctree: generated/
    :template: autosummary/accessor_attribute.rst
 
+    DataArray.cf.axes
+    DataArray.cf.cell_measures
+    DataArray.cf.coordinates
+    DataArray.cf.standard_names
     DataArray.cf.plot
 
 .. autosummary::
    :toctree: generated/
    :template: autosummary/accessor_method.rst
 
+    DataArray.cf.__getitem__
     DataArray.cf.describe
-    DataArray.cf.standard_names
-    DataArray.cf.keys
-    DataArray.cf.axes
-    DataArray.cf.coordinates
-    DataArray.cf.cell_measures
     DataArray.cf.guess_coord_axis
+    DataArray.cf.keys
     DataArray.cf.rename_like
 
 Dataset
@@ -32,20 +33,23 @@ Dataset
    :toctree: generated/
    :template: autosummary/accessor_attribute.rst
 
+    Dataset.cf.axes
+    Dataset.cf.cell_measures
+    Dataset.cf.coordinates
+    Dataset.cf.standard_names
+
 .. autosummary::
    :toctree: generated/
    :template: autosummary/accessor_method.rst
 
+    DataArray.cf.__getitem__
     Dataset.cf.add_bounds
+    Dataset.cf.bounds_to_vertices
     Dataset.cf.decode_vertical_coords
     Dataset.cf.describe
     Dataset.cf.get_bounds
-    Dataset.cf.bounds_to_vertices
-    Dataset.cf.standard_names
-    Dataset.cf.keys
-    Dataset.cf.axes
-    Dataset.cf.coordinates
     Dataset.cf.guess_coord_axis
+    Dataset.cf.keys
     Dataset.cf.rename_like
 
 .. currentmodule:: cf_xarray

doc/conf.py

@@ -315,6 +315,10 @@
 autosummary_generate = True
 
 autodoc_typehints = "none"
-
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+    "private-members": True,
+}
 napoleon_use_param = True
 napoleon_use_rtype = True

doc/criteria.rst

@@ -26,7 +26,7 @@ Coordinates
 
 Names
 ~~~~~
-Regex used by :meth:`DataArray.cf.guess_coord_axis` and :meth:`Dataset.cf.guess_coord_axis` for identifying variables using their names.
+Regex used by :py:meth:`DataArray.cf.guess_coord_axis` and :py:meth:`Dataset.cf.guess_coord_axis` for identifying variables using their names.
 
 .. csv-table::
    :file: _build/csv/all_regex.csv

doc/whats-new.rst

@@ -1,4 +1,4 @@
-.. currentmodule:: cf_xarray
+.. currentmodule:: xarray
 
 What's New
 ----------
@@ -9,9 +9,9 @@ v0.4.1 (unreleased)
 - Added scripts to document CF criteria with tables. By `Mattia Almansi`_.
 - Support for ``.drop()``, ``.drop_vars()``, ``.drop_sel()``, ``.drop_dims()``, ``.set_coords()``, ``.reset_coords()``. By `Mattia Almansi`_.
 - Support for using ``standard_name`` in more functions. (:pr:`128`) By `Deepak Cherian`_
-- Allow ``DataArray.cf[]`` with standard names. By `Deepak Cherian`_
-- Rewrite the ``values`` of ``.cf.coords`` and ``.cf.data_vars`` with objects returned
-  by ``.cf.__getitem___``. This allows extraction of DataArrays when there are clashes
+- Allow :py:meth:`DataArray.cf.__getitem__` with standard names. By `Deepak Cherian`_
+- Rewrite the ``values`` of :py:attr:`Dataset.coords` and :py:attr:`Dataset.data_vars` with objects returned
+  by :py:meth:`Dataset.cf.__getitem__`. This allows extraction of DataArrays when there are clashes
   between DataArray names and "special" CF names like ``T``.
   (:issue:`129`, :pr:`130`). By `Deepak Cherian`_
 
@@ -23,13 +23,12 @@ v0.4.0 (Jan 22, 2021)
 
 v0.3.1 (Nov 25, 2020)
 =====================
-- Support ``Dataset.cf.cell_measures``. By `Deepak Cherian`_.
-- Added ``.axes`` to return a dictionary mapping available Axis standard names to variable names of an xarray object, ``.coordinates`` for Coordinates, 
-  ``.cell_measures`` for Cell Measures, and ``.standard_names`` for all variables. `Kristen Thyng`_ and `Mattia Almansi`_.
-- Changed ``get_valid_keys()`` to ``.keys()``. `Kristen Thyng`_.
-- Added ``.cf.decode_vertical_coords`` for decoding of parameterized vertical coordinate variables.
+- Support :py:attr:`Dataset.cf.cell_measures`. By `Deepak Cherian`_.
+- Added :py:attr:`Dataset.cf.axes` to return a dictionary mapping available Axis standard names to variable names of an xarray object, :py:attr:`Dataset.cf.coordinates` for Coordinates, :py:attr:`Dataset.cf.cell_measures` for Cell Measures, and :py:attr:`Dataset.cf.standard_names` for all variables. `Kristen Thyng`_ and `Mattia Almansi`_.
+- Changed :py:meth:`Dataset.cf.get_valid_keys` to :py:meth:`Dataset.cf.keys`. `Kristen Thyng`_.
+- Added :py:meth:`Dataset.cf.decode_vertical_coords` for decoding of parameterized vertical coordinate variables.
   (:issue:`34`, :pr:`103`). `Deepak Cherian`_.
-- Added top-level :py:func:`bounds_to_vertices` and :py:func:`vertices_to_bounds` as well as ``.cf.bounds_to_vertices``
+- Added top-level :py:func:`~cf_xarray.bounds_to_vertices` and :py:func:`~cf_xarray.vertices_to_bounds` as well as :py:meth:`Dataset.cf.bounds_to_vertices`
   to convert from coordinate bounds in a CF format (shape (nx, 2)) to a vertices format (shape (nx+1)).
   (:pr:`108`). `Pascal Bourgault`_.
 
@@ -45,7 +44,7 @@ model in particular. Thanks to Kristen Thyng for opening many issues.
 v0.2.1 (Aug 06, 2020)
 =====================
 - Support for the ``bounds`` attribute. (:pr:`68`, :issue:`32`). `Deepak Cherian`_.
-- Add ``.cf.guess_coord_axis`` to automagically guess axis and coord names, and add
+- Add :py:meth:`Dataset.cf.guess_coord_axis` to automagically guess axis and coord names, and add
   appropriate attributes. (:pr:`67`, :issue:`46`). `Deepak Cherian`_.
 
 v0.2.0 (Jul 28, 2020)
@@ -54,21 +53,22 @@ v0.2.0 (Jul 28, 2020)
 - ``cf_xarray`` is now available on conda-forge. Thanks to `Anderson Banihirwe`_ and `Filipe Fernandes`_
 - Remap datetime accessor syntax for groupby. E.g. ``.cf.groupby("T.month")`` → ``.cf.groupby("ocean_time.month")``.
   (:pr:`64`, :issue:`6`). `Julia Kent`_.
-- Added ``.cf.rename_like`` to rename matching variables. Only coordinate variables
+- Added :py:meth:`Dataset.cf.rename_like` to rename matching variables. Only coordinate variables
   i.e. those that match the criteria for ``("latitude", "longitude", "vertical", "time")``
   are renamed for now. (:pr:`55`) `Deepak Cherian`_.
-- Added ``.cf.add_bounds`` to add guessed bounds for 1D coordinates. (:pr:`53`) `Deepak Cherian`_.
+- Added :py:meth:`Dataset.cf.add_bounds` to add guessed bounds for 1D coordinates. (:pr:`53`) `Deepak Cherian`_.
 
 v0.1.5
 ======
+
+- Begin documenting things for contributors in :ref:`contribut`.
+- Parse ``ancillary_variables`` attribute. These variables are converted to coordinate variables.
+- Support :py:meth:`Dataset.reset_index`
 - Wrap ``.sizes`` and ``.chunks``. (:pr:`42`) `Deepak Cherian`_.
 
      >>> ds.cf.sizes
      {'X': 53, 'Y': 25, 'T': 2920, 'longitude': 53, 'latitude': 25, 'time': 2920}
 
-- Begin documenting things for contributors in :ref:`contribut`.
-- Parse ``ancillary_variables`` attribute. These variables are converted to coordinate variables.
-- Support ``reset_index``
 
 v0.1.4
 ======

setup.cfg

@@ -116,6 +116,6 @@ test = pytest
 nobeep = True
 
 [rstcheck]
-ignore_roles=pr,issue,meth
+ignore_roles=pr,issue,py:meth,py:attr
 ignore_directives=ipython,autodata,csv-table
 ignore_messages=(is not referenced\.$)