docs cleanup (#249)

Author: malmans2

cf_xarray/accessor.py

@@ -915,9 +915,9 @@ def _process_signature(
     ):
         """
         Processes a function's signature, args, kwargs:
-        1. Binds *args so that everthing is a Mapping from kwarg name to values
-        2. Calls _rewrite_values to rewrite any special CF names to normal xarray names.
-           This uses key_mappers
+        1. Binds ``*args`` so that everthing is a Mapping from kwarg name to values
+        2. Calls ``_rewrite_values`` to rewrite any special CF names to normal xarray names.
+           This uses ``key_mappers``
         3. Unpacks arguments if necessary before returning them.
         """
         sig = inspect.signature(func, follow_wrapped=False)

cf_xarray/scripts/make_doc.py

@@ -28,17 +28,17 @@ def make_criteria_csv():
 
     # Criteria tables
     df = DataFrame.from_dict(coordinate_criteria)
-    df = df.dropna(1, how="all")
+    df = df.dropna(axis=1, how="all")
     df = df.applymap(lambda x: ", ".join(sorted(x)) if isinstance(x, tuple) else x)
-    df = df.sort_index(0).sort_index(1)
+    df = df.sort_index(axis=0).sort_index(axis=1)
 
     # All criteria
     df.to_csv(os.path.join(csv_dir, "all_criteria.csv"))
 
     # Axes and coordinates
     for keys, name in zip([_AXIS_NAMES, _COORD_NAMES], ["axes", "coords"]):
-        subdf = df[sorted(keys)].dropna(1, how="all")
-        subdf = subdf.dropna(1, how="all").transpose()
+        subdf = df[sorted(keys)].dropna(axis=1, how="all")
+        subdf = subdf.dropna(axis=1, how="all").transpose()
         subdf.to_csv(os.path.join(csv_dir, f"{name}_criteria.csv"))
 
 
@@ -52,7 +52,7 @@ def make_regex_csv():
     os.makedirs(csv_dir, exist_ok=True)
     df = DataFrame(regex, index=[0])
     df = df.applymap(lambda x: f"``{x}``")
-    df = df.sort_index(1).transpose()
+    df = df.sort_index(axis=1).transpose()
     df.to_csv(os.path.join(csv_dir, "all_regex.csv"), header=False)
 
 

ci/doc.yml

@@ -14,6 +14,7 @@ dependencies:
   - sphinx-autosummary-accessors
   - ipython
   - ipykernel
+  - ipywidgets
   - pandas
   - pydata-sphinx-theme
   - pip:

doc/Makefile

@@ -18,3 +18,8 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: clean
+clean:
+	rm -rf $(BUILDDIR)/*
+	rm -rf generated/*

doc/conf.py

@@ -154,7 +154,7 @@
 html_theme_options = {
     "github_url": "https://github.com/xarray-contrib/cf-xarray",
     "use_edit_page_button": True,
-    "search_bar_position": "navbar",
+    "navbar_end": "search-field.html",
 }
 
 html_context = {
@@ -322,3 +322,5 @@
 }
 napoleon_use_param = True
 napoleon_use_rtype = True
+
+numpydoc_show_class_members = False

doc/contributing.rst

@@ -59,8 +59,15 @@ Primarily for developer reference. Some of these could become public API if nece
    :toctree: generated/
 
     ~accessor._getattr
+    ~accessor._getitem
+    ~accessor._get_all
     ~accessor._get_axis_coord
-    ~accessor._get_axis_coord_single
+    ~accessor._get_bounds
+    ~accessor._get_coords
+    ~accessor._get_custom_criteria
+    ~accessor._get_dims
+    ~accessor._get_groupby_time_accessor
+    ~accessor._get_indexes
     ~accessor._get_measure
-    ~accessor._get_measure_variable
-    accessor._CFWrappedPlotMethods._plot_decorator
+    ~accessor._get_with_standard_name
+