DOC: create usable env on RTD, update clustering (#601)

* update example * use top level osmnx import * exectue notebooks * cast tessellation to gdf * fix path * don't build notebooks but try getting a working env
pysal · Jun 14, 2024 · 5d440a5 · 5d440a5
1 parent f2eb9b4
commit 5d440a5
Show file tree

Hide file tree

Showing 15 changed files with 6,236 additions and 6,258 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,24 +20,24 @@
 
 import momepy  # noqa
 
-autodoc_mock_imports = [
-    "geopandas",
-    "networkx",
-    "numpy",
-    "pandas",
-    "rtree",
-    "scipy",
-    "scipy.spatial",
-    "shapely",
-    "shapely.geometry",
-    "shapely.wkt",
-    "shapely.ops",
-    "libpysal",
-    "tqdm",
-    "mapclassify",
-    "osmnx",
-    "inequality",
-]
+# autodoc_mock_imports = [
+#     "geopandas",
+#     "networkx",
+#     "numpy",
+#     "pandas",
+#     "rtree",
+#     "scipy",
+#     "scipy.spatial",
+#     "shapely",
+#     "shapely.geometry",
+#     "shapely.wkt",
+#     "shapely.ops",
+#     "libpysal",
+#     "tqdm",
+#     "mapclassify",
+#     "osmnx",
+#     "inequality",
+# ]
 
 # -- Project information -----------------------------------------------------
 

diff --git a/docs/environment.yml b/docs/environment.yml
@@ -0,0 +1,43 @@
+name: test
+channels:
+  - conda-forge
+dependencies:
+  - python=3.12
+  - geopandas
+  - inequality
+  - libpysal>=4.11.0
+  - mapclassify
+  - networkx
+  - osmnx
+  - packaging
+  - pandas!=1.5.0
+  - shapely>=2
+  - esda
+  - tqdm
+  - numba
+  # testing
+  - codecov
+  - pytest
+  - pytest-cov
+  # user guide
+  - inequality
+  - jupyter
+  - matplotlib
+  - osmnx
+  - clustergram
+  - bokeh
+  - geopy
+  - ipywidgets
+  - Iprogress
+  - matplotlib
+  - numpydoc
+  - pydata-sphinx-theme
+  - nbsphinx
+  - myst-parser
+  - pip
+  - pip:
+    - sphinx_copybutton
+    - sphinx-gallery
+    - sphinxext-rediraffe
+    - sphinxcontrib.bibtex
+    - git+https://github.com/geopandas/geopandas.git
diff --git a/docs/examples/clustering.ipynb b/docs/examples/clustering.ipynb
diff --git a/docs/user_guide/combined/distribution.ipynb b/docs/user_guide/combined/distribution.ipynb
diff --git a/docs/user_guide/combined/intensity.ipynb b/docs/user_guide/combined/intensity.ipynb
diff --git a/docs/user_guide/elements/enclosed.ipynb b/docs/user_guide/elements/enclosed.ipynb
diff --git a/docs/user_guide/elements/tessellation.ipynb b/docs/user_guide/elements/tessellation.ipynb
diff --git a/docs/user_guide/getting_started.ipynb b/docs/user_guide/getting_started.ipynb
diff --git a/docs/user_guide/simple/dimension.ipynb b/docs/user_guide/simple/dimension.ipynb
diff --git a/docs/user_guide/simple/shape.ipynb b/docs/user_guide/simple/shape.ipynb
diff --git a/docs/user_guide/weights/diversity.ipynb b/docs/user_guide/weights/diversity.ipynb
diff --git a/docs/user_guide/weights/examples.ipynb b/docs/user_guide/weights/examples.ipynb
diff --git a/docs/user_guide/weights/two.ipynb b/docs/user_guide/weights/two.ipynb
diff --git a/docs/user_guide/weights/weights_nb.ipynb b/docs/user_guide/weights/weights_nb.ipynb
diff --git a/readthedocs.yml b/readthedocs.yml
@@ -1,16 +1,19 @@
 version: 2
-formats: []
-
-sphinx:
-  configuration: docs/conf.py
-
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: mambaforge-latest
+  jobs:
+    post_checkout:
+      # we need the tags for versioneer to work
+      - git fetch origin --depth 150
+      - git fetch --tags
+    post_build:
+      - mamba list
 python:
   install:
-  - requirements: docs/requirements.txt
   - method: pip
     path: .
-
+conda:
+  environment: docs/environment.yml
+formats: []