🚸 Walkthrough on rasterizing vector polygons into label masks

.readthedocs.yml

@@ -9,6 +9,8 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.10"
+  apt_packages:
+    - graphviz
   jobs:
     pre_build:
       # Generate the Sphinx configuration for this Jupyter Book so it builds.

docs/CONTRIBUTING.md

@@ -121,6 +121,7 @@ poetry install --extras "raster spatial vector"
 
 ```
 poetry install --extras=docs  # or `pip install .[docs]`
+sudo apt install graphviz  # if rendering graphviz plots
 jupyter-book build docs/
 ```
 

docs/_config.yml

@@ -4,10 +4,12 @@
 title: zen3geo
 author: The zen3geo Team
 
-# Force re-execution of notebooks on each build.
+# Cache execution outputs of notebooks on each build.
 # See https://jupyterbook.org/content/execute.html
 execute:
   execute_notebooks: cache
+  # https://jupyterbook.org/en/latest/content/execute.html#setting-execution-timeout
+  timeout: 300
 
 # Define the name of the latex output file for PDF builds
 latex:
@@ -30,6 +32,7 @@ html:
 sphinx:
   config:
     autodoc_typehints: 'description'
+    execution_show_tb: True
     html_show_copyright: false
     html_theme_options:
       # https://sphinx-book-theme.readthedocs.io/en/stable/customize/sidebar-secondary.html
@@ -63,7 +66,7 @@ sphinx:
         - 'https://pytorch.org/data/main'
         - null
       xarray:
-        - 'https://xarray.pydata.org/en/latest/'
+        - 'https://docs.xarray.dev/en/latest/'
         - null
       xbatcher:
         - 'https://xbatcher.readthedocs.io/en/latest/'

docs/_toc.yml

@@ -9,6 +9,8 @@ chapters:
     sections:
       - title: 🀄 Chipping and Batching
         file: chipping
+      - title: 🫧 Vector Segmentation Masks
+        file: vector-segmentation-masks
   - title: 📖 API Reference
     file: api
   - title: 📆 Changelog