Skip to content

Commit 1b7735d

Browse files
mdpipermdpiper
committed
Rebuild docs
1 parent ab31a5f commit 1b7735d

File tree

2 files changed

+64
-62
lines changed

2 files changed

+64
-62
lines changed

‎docs/source/CHANGES.rst

+55-53
Original file line numberDiff line numberDiff line change
@@ -4,162 +4,164 @@ Changes for bmi-topography
44
0.8.6 (unreleased)
55
------------------
66

7-
- Make an examples landing page (#77)
7+
- Update project metadata and CI workflows (#79)
8+
- Switch from Mambaforge to Miniforge (#78)
9+
- Make an examples landing page (#77)
810

911
0.8.5 (2024-08-18)
1012
------------------
1113

12-
- Check example notebooks (#75)
13-
- Simplify the test CI workflow (#74)
14-
- Cancel in-progress CI workflows on new push (#73)
15-
- Use pre-commit for linting and formatting (#72)
16-
- De-lint project files (#71)
14+
- Check example notebooks (#75)
15+
- Simplify the test CI workflow (#74)
16+
- Cancel in-progress CI workflows on new push (#73)
17+
- Use pre-commit for linting and formatting (#72)
18+
- De-lint project files (#71)
1719

1820
.. _section-1:
1921

2022
0.8.4 (2024-03-28)
2123
------------------
2224

23-
- Update docs build (#68)
24-
- Set minimum python>=3.10 (#67)
25-
- Link to project contributing and code of conduct docs (#65)
25+
- Update docs build (#68)
26+
- Set minimum python>=3.10 (#67)
27+
- Link to project contributing and code of conduct docs (#65)
2628

2729
.. _section-2:
2830

2931
0.8.3 (2023-12-18)
3032
------------------
3133

32-
- Build and test with Python 3.12 (#60)
33-
- Remove setuptools files in favor of pyproject.toml (#59)
34-
- Fix failing docs build (#58)
35-
- Use nox in CI testing (#54)
34+
- Build and test with Python 3.12 (#60)
35+
- Remove setuptools files in favor of pyproject.toml (#59)
36+
- Fix failing docs build (#58)
37+
- Use nox in CI testing (#54)
3638

3739
.. _section-3:
3840

3941
0.8.2 (2023-02-06)
4042
------------------
4143

42-
- Fix problem getting CRS info for AAIGrid type (#53)
44+
- Fix problem getting CRS info for AAIGrid type (#53)
4345

4446
.. _section-4:
4547

4648
0.8.1 (2023-01-27)
4749
------------------
4850

49-
- Run test CI on Windows with Python 3.10 (#52)
50-
- Use nox instead of make for building and testing project (#51)
51-
- Update project metadata files (#50)
52-
- Use rio accessor for geospatial information (#47)
53-
- Update contents of source and binary distributions (#46)
51+
- Run test CI on Windows with Python 3.10 (#52)
52+
- Use nox instead of make for building and testing project (#51)
53+
- Update project metadata files (#50)
54+
- Use rio accessor for geospatial information (#47)
55+
- Update contents of source and binary distributions (#46)
5456

5557
.. _section-5:
5658

5759
0.8 (2022-07-05)
5860
----------------
5961

60-
- Switch from xarray to rioxarray (#45)
61-
- Move metadata from setup.cfg to pyproject.toml (#44)
62+
- Switch from xarray to rioxarray (#45)
63+
- Move metadata from setup.cfg to pyproject.toml (#44)
6264

6365
.. _section-6:
6466

6567
0.7.1 (2022-06-03)
6668
------------------
6769

68-
- Provide a better reason for 401 errors (#41)
70+
- Provide a better reason for 401 errors (#41)
6971

7072
.. _section-7:
7173

7274
0.7 (2022-03-24)
7375
----------------
7476

75-
- Support all OpenTopography global datasets (#39)
76-
- Create test matrix of datasets and file types (#38)
77+
- Support all OpenTopography global datasets (#39)
78+
- Create test matrix of datasets and file types (#38)
7779

7880
.. _section-8:
7981

8082
0.6 (2022-02-17)
8183
----------------
8284

83-
- Use dashes in command line options (#36)
84-
- Use a demo API key if a user key can’t be found (#34)
85+
- Use dashes in command line options (#36)
86+
- Use a demo API key if a user key can’t be found (#34)
8587

8688
.. _section-9:
8789

8890
0.5.1 (2022-02-15)
8991
------------------
9092

91-
- Document use of OpenTopography API key (#33)
92-
- Add text to exception raised when API key is missing (#32)
93-
- Use new black syntax (#31)
93+
- Document use of OpenTopography API key (#33)
94+
- Add text to exception raised when API key is missing (#32)
95+
- Use new black syntax (#31)
9496

9597
.. _section-10:
9698

9799
0.5 (2022-01-25)
98100
----------------
99101

100-
- Use an API key when requesting OpenTopography data (#25)
101-
- Add python 3.10 to tests (#24)
102-
- Address technical debt (#22)
102+
- Use an API key when requesting OpenTopography data (#25)
103+
- Add python 3.10 to tests (#24)
104+
- Address technical debt (#22)
103105

104106
.. _section-11:
105107

106108
0.4 (2021-09-03)
107109
----------------
108110

109-
- Support ALOS World 3D 30m products (#13)
110-
- Support .asc and .img files (#14)
111-
- Add format job to CI
112-
- Use CITATION.cff file
111+
- Support ALOS World 3D 30m products (#13)
112+
- Support .asc and .img files (#14)
113+
- Add format job to CI
114+
- Use CITATION.cff file
113115

114116
.. _section-12:
115117

116118
0.3.2 (2021-04-23)
117119
------------------
118120

119-
- Add citation recommendation with DOI
120-
- Fix typos, update text in example notebooks
121-
- Create CREDITS.md and rearrange docs
121+
- Add citation recommendation with DOI
122+
- Fix typos, update text in example notebooks
123+
- Create CREDITS.md and rearrange docs
122124

123125
.. _section-13:
124126

125127
0.3.1 (2021-03-04)
126128
------------------
127129

128-
- Install with conda
129-
- Include shell script demonstrating CLI
130+
- Install with conda
131+
- Include shell script demonstrating CLI
130132

131133
.. _section-14:
132134

133135
0.3 (2021-02-25)
134136
----------------
135137

136-
- Update README with overview and install instructions
137-
- Write documentation
138+
- Update README with overview and install instructions
139+
- Write documentation
138140

139141
.. _section-15:
140142

141143
0.2 (2021-02-24)
142144
----------------
143145

144-
- Implement BMI for Topography class from template generated by
145-
``bmipy-render``
146-
- Include sample config file and Jupyter Notebook to demo BMI
147-
- Add CI with GitHub Actions
146+
- Implement BMI for Topography class from template generated by
147+
``bmipy-render``
148+
- Include sample config file and Jupyter Notebook to demo BMI
149+
- Add CI with GitHub Actions
148150

149151
.. _section-16:
150152

151153
0.1.1 (2021-02-22)
152154
------------------
153155

154-
- Add Makefile rule to test upload to TestPyPI
155-
- Test upload to TestPyPI
156+
- Add Makefile rule to test upload to TestPyPI
157+
- Test upload to TestPyPI
156158

157159
.. _section-17:
158160

159161
0.1 (2021-02-22)
160162
----------------
161163

162-
- Create base library that calls OpenTopography API
163-
- Create CLI for library
164-
- Write tests for library and CLI
165-
- Include demo Jupyter Notebook for library
164+
- Create base library that calls OpenTopography API
165+
- Create CLI for library
166+
- Write tests for library and CLI
167+
- Include demo Jupyter Notebook for library

‎docs/source/README.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ API <https://portal.opentopography.org/apidocs/>`__.
1212
The *bmi-topography* library provides access to the following global
1313
raster datasets:
1414

15-
- SRTMGL3 (SRTM GL3 90m)
16-
- SRTMGL1 (SRTM GL1 30m)
17-
- SRTMGL1_E (SRTM GL1 Ellipsoidal 30m)
18-
- AW3D30 (ALOS World 3D 30m)
19-
- AW3D30_E (ALOS World 3D Ellipsoidal, 30m)
20-
- SRTM15Plus (Global Bathymetry SRTM15+ V2.1)
21-
- NASADEM (NASADEM Global DEM)
22-
- COP30 (Copernicus Global DSM 30m)
23-
- COP90 (Copernicus Global DSM 90m)
15+
- SRTMGL3 (SRTM GL3 90m)
16+
- SRTMGL1 (SRTM GL1 30m)
17+
- SRTMGL1_E (SRTM GL1 Ellipsoidal 30m)
18+
- AW3D30 (ALOS World 3D 30m)
19+
- AW3D30_E (ALOS World 3D Ellipsoidal, 30m)
20+
- SRTM15Plus (Global Bathymetry SRTM15+ V2.1)
21+
- NASADEM (NASADEM Global DEM)
22+
- COP30 (Copernicus Global DSM 30m)
23+
- COP90 (Copernicus Global DSM 90m)
2424

2525
The library includes an API and a CLI that accept the dataset type, a
2626
latitude-longitude bounding box, and the output file format. Data are

0 commit comments

Comments
 (0)