Merge remote-tracking branch 'origin/main' into generalize_rlatrlon_l…

…atlon

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ default_language_version:
 
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.8.0
+    rev: v3.9.0
     hooks:
     -   id: pyupgrade
         args: [--py39-plus]
@@ -27,7 +27,7 @@ repos:
     hooks:
       - id: rst-inline-touching-normal
   - repo: https://github.com/psf/black
-    rev: 23.3.0
+    rev: 23.7.0
     hooks:
       - id: black
         exclude: ^docs/

CONTRIBUTING.rst

@@ -42,11 +42,6 @@ xscen could always use more documentation, whether as part of the
 official xscen docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
-Currently, the documentation includes notebooks and sample catalogs which use private
-internal data from Ouranos. As such, they are not included in this public repo. Rather,
-a git submodule allows people with access to the Ouranos VPN to recursively fetch them
-from an internal Gitlab server.
-
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
@@ -64,17 +59,15 @@ Get Started!
 
 Ready to contribute? Here's how to set up `xscen` for local development.
 
-1. Clone the repo locally, including the notebooks::
+1. Clone the repo locally::
 
-    $ git clone --recurse-submodules git@github.com:Ouranosinc/xscen.git
+    $ git clone git@github.com:Ouranosinc/xscen.git
 
-If this command is not executed from within the Ouranos VPN, it will show error messages about
-the `docs/notebooks` submodule not being fetched, but this doesn't affect the usage of xscen in general.
 
-2. Install your local copy into an isolated environment. We usually use `conda` for this::
+2. Install your local copy into an isolated environment. We usually use `mamba` or `conda` for this::
 
     $ cd xscen/
-    $ conda env create -f environment-dev.yml
+    $ mamba env create -f environment-dev.yml
     $ pip install -e .
 
 3. To ensure a consistent style, please install the pre-commit hooks to your repo::
@@ -111,29 +104,14 @@ the `docs/notebooks` submodule not being fetched, but this doesn't affect the us
     $ git commit -m "Your detailed description of your changes."
     $ git push origin name-of-your-bugfix-or-feature
 
-7. If you are editing the docs (but not the notebooks, nor the sample catalogs),
-   compile and open them with::
+7. If you are editing the docs, compile and open them with::
 
     $ make docs
     # or to simply generate the html
     $ cd docs/
     $ make html
 
-8. If you are editing the notebooks or the sample catalogs, building the docs is done
-   the same way, but you have to commit your changes to the internal `xscen-notebooks`
-   repository instead of the public one. This assumes you are in the Ouranos VPN and
-   have a Gitlab account on the internal server.::
-
-   $ cd docs/notebooks # Now git commands are made to the notebook repo.
-   $ git checkout -b new-branch
-   $ git commit -am "detailed description of your changes"
-   $ git push origin new-branch
-   $ cd ../..
-   $ git commit -am 'updated the notebooks'  # This updates the commit to which the submodule points
-
-9. Submit a pull request through the GitHub website, or the gitlab one for changes to the notebooks
-   and sample catalogs. If your changes necessitate both a github PR and a gitlab MR, please make sure
-   that the notebooks changes have been merged and the submodules updated before merging the main PR.
+8. Submit a pull request through the GitHub website.
 
 Pull Request Guidelines
 -----------------------

HISTORY.rst

@@ -8,7 +8,7 @@ Contributors to this version: Gabriel Rondeau-Genesse (:user:`RondeauG`), Pascal
 
 Announcements
 ^^^^^^^^^^^^^
-* Dropped support for Python 3.8, added support for 3.11. (:pull:`199`,:pull:`222`).
+* Dropped support for Python 3.8, added support for 3.11. (:pull:`199`, :pull:`222`).
 
 New features and enhancements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -29,6 +29,7 @@ Bug fixes
 ^^^^^^^^^
 * Fix bug in ``unstack_dates`` with seasonal climatological mean. (:issue:`202`, :pull:`202`).
 * Added NotImplemented errors when trying to call `climatological_mean` and `compute_deltas` with daily data. (:pull:`187`).
+* Minor documentation fixes. (:issue:`223`, :pull:`225`).
 
 Internal changes
 ^^^^^^^^^^^^^^^^