build(deps): bump ncipollo/release-action from 1.14.0 to 1.16.0

.github/workflows/release.yml

@@ -61,15 +61,22 @@ jobs:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v4
 
+      - name: add first release to changelog
+        run: |
+          RELEASE_DATE=$(date +'%Y-%m-%d')
+          sed -i "1a \n## v0.1.0 - $RELEASE_DATE\n\n- first release" CHANGELOG.md
+        if: github.event.ref == 'refs/tags/v0.1.0'
+
       - name: update changelog
         id: changelog
         uses: requarks/changelog-action@v1
         with:
           token: ${{ github.token }}
           tag: ${{ github.ref_name }}
+        if: github.event.ref != 'refs/tags/v0.1.0'
 
       - name: create release
-        uses: ncipollo/release-action@v1.14.0
+        uses: ncipollo/release-action@v1.16.0
         with:
           allowUpdates: true
           draft: false

docs/conf.py

@@ -3,17 +3,29 @@
 import os
 import sys
 
+import pkg_resources
+
 project = "multiurbanpy"
 author = "Martí Bosch"
 
-__version__ = "0.1.0"
-version = __version__
-release = __version__
+release = pkg_resources.get_distribution("swisstopopy").version
+version = ".".join(release.split(".")[:2])
 
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "myst_parser"]
+extensions = [
+    "myst_parser",
+    "nbsphinx",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+]
 
 autodoc_typehints = "description"
-html_theme = "default"
+html_theme = "pydata_sphinx_theme"
+html_theme_options = {
+    "github_url": "https://github.com/martibosch/swisstopopy",
+}
 
 # add module to path
 sys.path.insert(0, os.path.abspath(".."))
+
+# do NOT execute notebooks
+nbsphinx_execute = "never"

docs/environment.yml

@@ -1,9 +1,12 @@
 name: multiurbanpy
 channels:
-    - conda-forge
+  - conda-forge
 dependencies:
-    - python=3.13
-    - gdal=3.10.2
-    - myst-parser=4.0.1
-    - sphinx=8.2.3
-    - pip=25.0.1
+  - gdal=3.10.2
+  - myst-parser=4.0.1
+  - nbsphinx=0.9.7
+  - pip=25.0.1
+  - pydata-sphinx-theme=0.16.1
+  - python=3.13
+  - setuptools=75.8.2
+  - sphinx=8.2.3

multiurbanpy/__init__.py

@@ -1,5 +1,5 @@
 """multiurbanpy."""
 
-from multiurbanpy.core import MultiScaleFeatureComputer, generate_regular_grid_gser
+from multiurbanpy.core import MultiScaleFeatureComputer
 
 __version__ = "0.1.0"