Skip to content

Commit

Permalink
Move notebooks to their own section (#118)
Browse files Browse the repository at this point in the history
<!-- Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [x] This PR addresses an already opened issue (for bug fixes /
features)
  - This PR fixes #114 
- [x] (If applicable) Documentation has been added / updated (for bug
fixes / features).
- [x] (If applicable) Tests have been added.
- [x] CHANGES.rst has been updated (with summary of main changes).
- [x] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added.

### What kind of change does this PR introduce?

* Move all notebooks under a "Usage" section.

### Does this PR introduce a breaking change?


### Other information:
RondeauG authored Mar 13, 2024

Verified

This commit was signed with the committer’s verified signature. The key has expired.
mmarchini mary marchini
2 parents 87e8056 + abc2595 commit 75fc0ab
Showing 4 changed files with 13 additions and 14 deletions.
3 changes: 2 additions & 1 deletion CHANGES.rst
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@ Changelog

v0.4.0 (unreleased)
-------------------
Contributors to this version: Trevor James Smith (:user:`Zeitsperre`), Thomas-Charles Fortier Filion (:user:`TC-FF`), Sébastien Langlois (:user:`sebastienlanglois`).
Contributors to this version: Trevor James Smith (:user:`Zeitsperre`), Thomas-Charles Fortier Filion (:user:`TC-FF`), Sébastien Langlois (:user:`sebastienlanglois`), Gabriel Rondeau-Genesse (:user:`RondeauG`).

New features and enhancements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -21,6 +21,7 @@ Internal changes
* Added a `Makefile` recipe to facilitate installation of `esmpy` when `esmf` is installed and visible on the `$PATH`.
* Added a `Makefile` recipe for running tests over Jupyter notebooks.
* Synchronized dependencies between `pyproject.toml` and `conda` configuration files.
* Moved the notebooks under a Usage section in the documentation. (:issue:`114`, :pull:`118`).

v0.3.4 (2024-02-29)
-------------------
5 changes: 1 addition & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -8,10 +8,7 @@ Welcome to xHydro's documentation!

readme
installation
usage
notebooks/gis
notebooks/local_frequency_analysis
notebooks/climate_change
notebooks/index
planification
apidoc/modules
contributing
10 changes: 10 additions & 0 deletions docs/notebooks/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Usage
=====

.. toctree::
:maxdepth: 1
:numbered:

gis
local_frequency_analysis
climate_change
9 changes: 0 additions & 9 deletions docs/usage.rst

This file was deleted.

0 comments on commit 75fc0ab

Please sign in to comment.