Skip to content

Commit

Permalink
Update documentation sources
Browse files Browse the repository at this point in the history
  • Loading branch information
mdpiper committed Aug 18, 2024
1 parent c3d4ef7 commit f77afe3
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 20 deletions.
44 changes: 28 additions & 16 deletions docs/source/CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
Changes for bmi-topography
==========================

0.8.4 (unreleased)
0.8.5 (unreleased)
------------------

- Check example notebooks (#75)
- Simplify the test CI workflow (#74)
- Cancel in-progress CI workflows on new push (#73)
- Use pre-commit for linting and formatting (#72)
- De-lint project files (#71)

0.8.4 (2024-03-28)
------------------

- Update docs build (#68)
- Set minimum python>=3.10 (#67)
- Link to project contributing and code of conduct docs (#65)

.. _section-1:

0.8.3 (2023-12-18)
------------------

Expand All @@ -15,14 +27,14 @@ Changes for bmi-topography
- Fix failing docs build (#58)
- Use nox in CI testing (#54)

.. _section-1:
.. _section-2:

0.8.2 (2023-02-06)
------------------

- Fix problem getting CRS info for AAIGrid type (#53)

.. _section-2:
.. _section-3:

0.8.1 (2023-01-27)
------------------
Expand All @@ -33,38 +45,38 @@ Changes for bmi-topography
- Use rio accessor for geospatial information (#47)
- Update contents of source and binary distributions (#46)

.. _section-3:
.. _section-4:

0.8 (2022-07-05)
----------------

- Switch from xarray to rioxarray (#45)
- Move metadata from setup.cfg to pyproject.toml (#44)

.. _section-4:
.. _section-5:

0.7.1 (2022-06-03)
------------------

- Provide a better reason for 401 errors (#41)

.. _section-5:
.. _section-6:

0.7 (2022-03-24)
----------------

- Support all OpenTopography global datasets (#39)
- Create test matrix of datasets and file types (#38)

.. _section-6:
.. _section-7:

0.6 (2022-02-17)
----------------

- Use dashes in command line options (#36)
- Use a demo API key if a user key can’t be found (#34)

.. _section-7:
.. _section-8:

0.5.1 (2022-02-15)
------------------
Expand All @@ -73,7 +85,7 @@ Changes for bmi-topography
- Add text to exception raised when API key is missing (#32)
- Use new black syntax (#31)

.. _section-8:
.. _section-9:

0.5 (2022-01-25)
----------------
Expand All @@ -82,7 +94,7 @@ Changes for bmi-topography
- Add python 3.10 to tests (#24)
- Address technical debt (#22)

.. _section-9:
.. _section-10:

0.4 (2021-09-03)
----------------
Expand All @@ -92,7 +104,7 @@ Changes for bmi-topography
- Add format job to CI
- Use CITATION.cff file

.. _section-10:
.. _section-11:

0.3.2 (2021-04-23)
------------------
Expand All @@ -101,23 +113,23 @@ Changes for bmi-topography
- Fix typos, update text in example notebooks
- Create CREDITS.md and rearrange docs

.. _section-11:
.. _section-12:

0.3.1 (2021-03-04)
------------------

- Install with conda
- Include shell script demonstrating CLI

.. _section-12:
.. _section-13:

0.3 (2021-02-25)
----------------

- Update README with overview and install instructions
- Write documentation

.. _section-13:
.. _section-14:

0.2 (2021-02-24)
----------------
Expand All @@ -127,15 +139,15 @@ Changes for bmi-topography
- Include sample config file and Jupyter Notebook to demo BMI
- Add CI with GitHub Actions

.. _section-14:
.. _section-15:

0.1.1 (2021-02-22)
------------------

- Add Makefile rule to test upload to TestPyPI
- Test upload to TestPyPI

.. _section-15:
.. _section-16:

0.1 (2021-02-22)
----------------
Expand Down
8 changes: 4 additions & 4 deletions docs/source/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,14 +220,14 @@ https://bmi-topography.readthedocs.io.
<!-- Links (by alpha) -->
.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8327417.svg
:target: https://doi.org/10.5281/zenodo.8327417
.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4608652.svg
:target: https://doi.org/10.5281/zenodo.4608652
.. |Conda Version| image:: https://img.shields.io/conda/vn/conda-forge/bmi-topography.svg
:target: https://anaconda.org/conda-forge/bmi-topography
.. |PyPI| image:: https://img.shields.io/pypi/v/bmi-topography
:target: https://pypi.org/project/bmi-topography
.. |Build/Test CI| image:: https://github.com/csdms/bmi-topography/actions/workflows/build-test-ci.yml/badge.svg
:target: https://github.com/csdms/bmi-topography/actions/workflows/build-test-ci.yml
.. |Build/Test CI| image:: https://github.com/csdms/bmi-topography/actions/workflows/test.yml/badge.svg
:target: https://github.com/csdms/bmi-topography/actions/workflows/test.yml
.. |Coverage Status| image:: https://coveralls.io/repos/github/csdms/bmi-topography/badge.svg?branch=main
:target: https://coveralls.io/github/csdms/bmi-topography?branch=main
.. |Documentation Status| image:: https://readthedocs.org/projects/bmi-topography/badge/?version=latest
Expand Down

0 comments on commit f77afe3

Please sign in to comment.