Skip to content

Commit dd095c0

Browse files
committed
Simplify docs
1 parent 74b8759 commit dd095c0

File tree

2 files changed

+1
-61
lines changed

2 files changed

+1
-61
lines changed

docs/api.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
11
# API Reference
22

3-
## xpx Function
4-
53
::: xarray_plotly.xpx
6-
options:
7-
show_root_heading: true
8-
9-
## Accessor
104

115
::: xarray_plotly.accessor.DataArrayPlotlyAccessor
126
options:
13-
show_root_heading: true
147
members:
158
- line
169
- bar
@@ -19,36 +12,16 @@
1912
- box
2013
- imshow
2114

22-
## Plotting Functions
23-
24-
::: xarray_plotly.plotting
25-
options:
26-
show_root_heading: true
27-
members:
28-
- line
29-
- bar
30-
- area
31-
- scatter
32-
- box
33-
- imshow
34-
35-
## Configuration
36-
3715
::: xarray_plotly.config
3816
options:
39-
show_root_heading: true
4017
members:
4118
- notebook
4219
- get_options
4320
- set_options
4421
- Options
45-
- DEFAULT_SLOT_ORDERS
46-
47-
## Common Utilities
4822

4923
::: xarray_plotly.common
5024
options:
51-
show_root_heading: true
5225
members:
5326
- auto
5427
- SLOT_ORDERS

docs/index.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,8 @@
1-
# xarray_plotly
2-
3-
**Interactive Plotly Express plotting accessor for xarray**
4-
51
::: xarray_plotly
62
options:
7-
show_root_heading: false
8-
show_docstring_description: true
9-
show_docstring_examples: true
3+
show_root_heading: true
104
members: false
115

12-
## Installation
13-
14-
```bash
15-
pip install xarray_plotly
16-
```
17-
18-
## Usage
19-
20-
```python
21-
import xarray as xr
22-
import numpy as np
23-
import xarray_plotly # registers the accessor
24-
25-
da = xr.DataArray(
26-
np.random.randn(100, 3).cumsum(axis=0),
27-
dims=["time", "city"],
28-
coords={"time": np.arange(100), "city": ["NYC", "LA", "Chicago"]},
29-
)
30-
31-
# Accessor style
32-
fig = da.plotly.line()
33-
34-
# Or with xpx() for IDE code completion
35-
from xarray_plotly import xpx
36-
fig = xpx(da).line()
37-
```
38-
396
## Next Steps
407

418
- [Getting Started](getting-started.ipynb) - Interactive tutorial

0 commit comments

Comments
 (0)