Improve resolution of Sphinx-Gallery figures and pin max Python versi…

…on for pip (#613)

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,5 +2,6 @@
 
  - [ ] Resolves #xxx,
  - [ ] Tests added, otherwise issue #xxx opened,
- - [ ] New optional dependencies added to both `dev-environment.yml` and `setup.cfg`,
  - [ ] Fully documented, including `api/*.md` for new API.
+ - [ ] New optional dependencies or Python version support added to both `dev-environment.yml` and `setup.cfg`,
+ - [ ] If contributor workflow (test, doc, linting) or Python version support changed, update `CONTRIBUTING.md`.

.github/workflows/pip-checks.yml

@@ -36,7 +36,7 @@ jobs:
           use-mamba: true
           channel-priority: strict
           activate-environment: geoutils-pip
-          python-version:
+          python-version: ${{ matrix.python-version }}
 
       # Use pip install
       - name: Install project

doc/source/conf.py

@@ -9,6 +9,7 @@
 sys.path.append(os.path.abspath("../.."))
 sys.path.append(os.path.abspath("../../geoutils/"))
 sys.path.append(os.path.abspath(".."))
+sys.path.insert(0, os.path.dirname(__file__))
 
 from sphinx_gallery.sorting import ExampleTitleSortKey, ExplicitOrder
 
@@ -104,6 +105,11 @@
     "backreferences_dir": "gen_modules/backreferences",
     "doc_module": ("geoutils"),  # Which function/class levels are used to create galleries
     "remove_config_comments": True,  # To remove comments such as sphinx-gallery-thumbnail-number (only works in code, not in text)
+    "reset_modules": (
+        "matplotlib",
+        "sphinxext.reset_mpl",
+    ),
+    # To reset matplotlib for each gallery (and run custom function that fixes the default DPI)
 }
 
 extlinks = {

doc/source/index.md

@@ -26,7 +26,7 @@ GeoUtils is a Python package for **accessible**, **efficient** and **reliable**
 
 ```{important}
 :class: margin
-GeoUtils ``v0.1`` is released, with most features drafted 3 years ago now finalized 🎉! We are working on an **Xarray accessor** and a few other features for 2024.
+GeoUtils ``v0.1`` is released, with most features drafted 3 years ago now finalized 🎉! We are working on an **Xarray accessor** and a few other features for 2025.
 ```
 
 GeoUtils is built on top of core geospatial packages (Rasterio, GeoPandas, PyProj) and numerical packages

doc/source/sphinxext.py

@@ -0,0 +1,8 @@
+"""Functions for documentation configuration only, importable by sphinx"""
+# To reset resolution setting for each sphinx-gallery example
+def reset_mpl(gallery_conf, fname):
+    # To get a good resolution for displayed figures
+    from matplotlib import pyplot
+
+    pyplot.rcParams["figure.dpi"] = 600
+    pyplot.rcParams["savefig.dpi"] = 600

setup.cfg

@@ -34,7 +34,7 @@ packages = find:
 scripts = bin/geoviewer.py
 zip_safe = False # https://mypy.readthedocs.io/en/stable/installed_packages.html
 include_package_data = True
-python_requires = >=3.9
+python_requires = >=3.9,<3.13
 # Avoid pinning dependencies in requirements.txt (which we don't do anyways, and we rely mostly on Conda)
 # (https://caremad.io/posts/2013/07/setup-vs-requirement/, https://github.com/pypa/setuptools/issues/1951)
 install_requires = file: requirements.txt