Skip to content

Commit 10fcac9

Browse files
committed
update sphinx config
1 parent 0322ba0 commit 10fcac9

3 files changed

Lines changed: 20 additions & 2 deletions

File tree

docs/conf.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,12 @@
9797
# theme further. For a list of options available for each theme, see the
9898
# documentation.
9999
#
100-
# html_theme_options = {}
100+
html_theme_options = {
101+
"fixed_sidebar": True,
102+
"github_button": True,
103+
"github_user": "data-exp-lab",
104+
"github_repo": "yt_xarray",
105+
}
101106

102107
# Add any paths that contain custom static files (such as style sheets) here,
103108
# relative to this directory. They are copied after the builtin static files,
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
yt\_xarray.YtAccessor
22
=====================
33

4+
To use the ``YtAccessor`` methods, simply ``import yt_xarray`` before
5+
loading your dataset. Accessor methods will then be available at ``ds.yt``.
6+
For example::
7+
8+
9+
import xarray as xr
10+
import yt_xarray
11+
12+
ds = xr.open_datset(...)
13+
ds.yt.load_grid(...)
14+
15+
The full method definitions are as follows:
16+
417
.. autoclass:: yt_xarray.YtAccessor
518
:members:
619
:show-inheritance:

yt_xarray/accessor/accessor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def load_grid(
5454
5555
use_callable : bool
5656
if True (default), then the yt dataset will utilize links to the open
57-
xarray Dataset handle to avoid copying memory.
57+
xarray Dataset handle to avoid copying data.
5858
5959
sel_dict: dict
6060
an optional selection dictionary to apply to the fields before yt dataset

0 commit comments

Comments
 (0)