Skip to content

Commit 2d097d1

Browse files
authored
Merge pull request #312 from google/docs-remove-prerelease-notes
Update docs for stable 0.1.0 release
2 parents ee1e779 + 776489c commit 2d097d1

4 files changed

Lines changed: 22 additions & 35 deletions

File tree

docs/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
# Xee Documentation (source files)
22

3-
> **⚠️ Breaking Change in v0.1.0**
3+
> **Breaking Change in v0.1.0+**
44
>
5-
> v0.1.0 includes breaking API changes.
5+
> Xee v0.1.0 introduced a refactored API with breaking changes relative to the 0.0.x series. The documentation in this folder reflects the v0.1.0+ API.
66
>
7-
> - Migration steps: [migration-guide-v0.1.0.md](migration-guide-v0.1.0.md)
8-
> - Install options (prerelease vs stable): [installation.md](installation.md)
7+
> If you are upgrading from 0.0.x, see [migration-guide-v0.1.0.md](migration-guide-v0.1.0.md).
98
109
## For nicely rendered documentation
1110

docs/index.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
11
# Xee Documentation
22

3-
```{admonition} Breaking Change in v0.1.0
3+
```{admonition} Breaking change in v0.1.0+
44
:class: warning
55
6-
A major refactor was released in v0.1.0, introducing breaking changes to the Xee API. In most cases, existing code written for pre-v0.1.0 versions will require updates to remain compatible.
6+
Xee v0.1.0 introduced a refactored API with breaking changes relative to the 0.0.x series. This documentation reflects the v0.1.0+ API.
77
8-
- See the [Migration Guide](migration-guide-v0.1.0.md) for details on updating your code.
9-
- If you need more time to migrate, you can pin your environment to the latest pre-v0.1.0 release.
10-
11-
During the v0.1.0 prerelease window, `pip install xee` and `conda install xee` may still install the previous stable line. To follow this documentation for the refactored API, install with `pip install --upgrade --pre xee` (or a pinned RC such as `pip install xee==0.1.0rc1`).
8+
If you are upgrading from 0.0.x, see the [Migration Guide](migration-guide-v0.1.0.md).
129
```
1310

14-
1511
Xee is an Xarray extension for Google Earth Engine that lets you open `ee.Image` and `ee.ImageCollection` objects as lazy `xarray.Dataset`s.
1612

1713
```{toctree}

docs/installation.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,39 @@
22

33
Install Xee with pip or conda. Use virtual environments (`venv`, conda envs) to avoid dependency conflicts.
44

5-
```{admonition} Temporary note for v0.1.0 prerelease
6-
:class: warning
5+
Xee v0.1.0 introduced a refactored API with breaking changes relative to the 0.0.x series. This page documents the v0.1.0+ install and usage path. If you are upgrading from 0.0.x, review the [Migration Guide](migration-guide-v0.1.0.md).
76

8-
This documentation describes the refactored v0.1.0 API. During the prerelease period, default install commands may still resolve to the previous stable line.
9-
```
10-
11-
## Install the v0.1.0 prerelease (refactored API)
7+
## Install
128

13-
Use pip prerelease resolution:
9+
Install from pip:
1410

1511
```shell
16-
pip install --upgrade --pre xee
12+
pip install --upgrade xee
1713
```
1814

19-
Or pin a specific release candidate:
15+
Install from conda-forge:
2016

2117
```shell
22-
pip install xee==0.1.0rc1
18+
conda install -c conda-forge xee
2319
```
2420

25-
## Install current stable (pre-v0.1.0 API)
21+
```{admonition} Prerelease versions
22+
:class: note
2623
27-
Install from pip:
24+
Before each stable release, Xee publishes one or more release candidates (e.g. `v0.1.1rc1`) to PyPI. If you want to test upcoming changes before the stable release:
2825
2926
```shell
30-
pip install --upgrade xee
27+
pip install --upgrade --pre xee
3128
```
3229

33-
Install from conda-forge:
30+
Or pin a specific release candidate:
3431

3532
```shell
36-
conda install -c conda-forge xee
33+
pip install xee==0.1.1rc1
3734
```
3835

39-
Note: conda-forge may lag PyPI during prerelease testing. Use pip for the latest RCs.
36+
Prerelease builds are not published to Conda-Forge.
37+
```
4038
4139
## Earth Engine setup
4240

docs/quickstart.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,11 @@ Get up and running with Xee in a few minutes.
88

99
## 1. Install
1010

11-
This quickstart uses the refactored v0.1.0 API. For canonical installation
12-
options (prerelease, stable, conda, and upgrade guidance), see
13-
[Installation](installation.md).
14-
15-
Fast path (latest v0.1.0 prerelease from pip):
16-
1711
```bash
18-
pip install --upgrade --pre xee
12+
pip install --upgrade xee
1913
```
2014

21-
Optional (plotting): `pip install matplotlib`.
15+
Optional (plotting): `pip install matplotlib`. For full installation options, see [Installation](installation.md).
2216

2317
## 2. Earth Engine access
2418

0 commit comments

Comments
 (0)