DAS-2155 - Merge datatree documentation into main docs. (pydata#9033)

Co-authored-by: Matt Savoie <[email protected]> Co-authored-by: Eni <[email protected]> Co-authored-by: Stephan Hoyer <[email protected]> Co-authored-by: Matt Savoie <[email protected]>
TomNicholas · Sep 12, 2024 · 18e5c87 · 18e5c87
1 parent 8bd456c
commit 18e5c87
Show file tree

Hide file tree

Showing 62 changed files with 1,052 additions and 3,305 deletions.
diff --git a/.github/workflows/ci-additional.yaml b/.github/workflows/ci-additional.yaml
@@ -81,8 +81,7 @@ jobs:
           #
           # If dependencies emit warnings we can't do anything about, add ignores to
           # `xarray/tests/__init__.py`.
-          # [MHS, 01/25/2024] Skip datatree_ documentation remove after #8572
-          python -m pytest --doctest-modules xarray --ignore xarray/tests --ignore xarray/datatree_ -Werror
+          python -m pytest --doctest-modules xarray --ignore xarray/tests -Werror
 
   mypy:
     name: Mypy

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -2,7 +2,6 @@
 ci:
     autoupdate_schedule: monthly
     autoupdate_commit_msg: 'Update pre-commit hooks'
-exclude: 'xarray/datatree_.*'
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0

diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/asv_bench/benchmarks/dataset_io.py b/asv_bench/benchmarks/dataset_io.py
@@ -7,8 +7,6 @@
 import pandas as pd
 
 import xarray as xr
-from xarray.backends.api import open_datatree
-from xarray.core.datatree import DataTree
 
 from . import _skip_slow, parameterized, randint, randn, requires_dask
 
@@ -556,7 +554,7 @@ def make_datatree(self, nchildren=10):
             for group in range(self.nchildren)
         }
         dtree = root | nested_tree1 | nested_tree2 | nested_tree3
-        self.dtree = DataTree.from_dict(dtree)
+        self.dtree = xr.DataTree.from_dict(dtree)
 
 
 class IOReadDataTreeNetCDF4(IONestedDataTree):
@@ -574,10 +572,10 @@ def setup(self):
         dtree.to_netcdf(filepath=self.filepath)
 
     def time_load_datatree_netcdf4(self):
-        open_datatree(self.filepath, engine="netcdf4").load()
+        xr.open_datatree(self.filepath, engine="netcdf4").load()
 
     def time_open_datatree_netcdf4(self):
-        open_datatree(self.filepath, engine="netcdf4")
+        xr.open_datatree(self.filepath, engine="netcdf4")
 
 
 class IOWriteNetCDFDask:

diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml
@@ -39,7 +39,8 @@ dependencies:
   - sphinx-copybutton
   - sphinx-design
   - sphinx-inline-tabs
-  - sphinx>=5.0
+  - sphinx>=5.0,<7.0 # https://github.com/executablebooks/sphinx-book-theme/issues/749
+  - sphinxcontrib-srclinks
   - sphinx-remove-toctrees
   - sphinxext-opengraph
   - sphinxext-rediraffe