Update docs

Author: Stefan Kuethe

docs/api/sources.md

@@ -0,0 +1,3 @@
+# Sources
+
+::: openlayers.sources

docs/concepts/layers.md

@@ -10,7 +10,7 @@ Sources state which data the map should display.
 -8<-- "concepts/sources.py"
 ```
 
-> See [Sources API](../../api/layers/)
+> See [Sources API](../../api/sources/)
 
 ## Layers
 

mkdocs.yml

@@ -43,6 +43,7 @@ nav:
       - Map: api/map.md
       - Controls: api/controls.md
       - Layers: api/layers.md
+      - Sources: api/sources.md
       - Styles: api/styles.md
       - Basemaps: api/basemaps.md
       - GeoPandas: api/geopandas.md

src/openlayers/models/layers.py

@@ -44,22 +44,12 @@ def validate_style(cls, v):
         return v
 
 
-# TODO: Inherit from `VectorTileLayer`
 class VectorLayer(VectorTileLayer):
     """A layer for rendering vector sources"""
 
     # style: dict | FlatStyle | None = default_style()
     fit_bounds: bool = Field(False, serialization_alias="fitBounds")
 
-    """
-    @field_validator("style")
-    def validate_style(cls, v):
-        if isinstance(v, FlatStyle):
-            return v.model_dump()
-
-        return v
-    """
-
 
 class VectorImageLayer(VectorLayer):
     """A layer for rendering vector sources
@@ -84,7 +74,11 @@ class WebGLVectorTileLayer(VectorTileLayer): ...
 
 
 class WebGLTileLayer(Layer):
-    # See https://openlayers.org/en/latest/apidoc/module-ol_layer_WebGLTile.html#~Style
+    """WebGLTile layer
+    
+    Note:
+        See [WebGLTile](https://openlayers.org/en/latest/apidoc/module-ol_layer_WebGLTile.html) for details.
+    """
     style: dict | None = None
 
 

src/openlayers/models/sources.py

@@ -27,7 +27,12 @@ class OSM(Source):
 
 
 class GeoTIFFSource(Source):
-    """GeoTIFF source"""
+    """GeoTIFF source
+
+    Examples:
+        >>> import ol
+        >>> geotiff = ol.GeoTIFFSource(sources=[{"url": "https://s2downloads.eox.at/demo/EOxCloudless/2020/rgbnir/s2cloudless2020-16bits_sinlge-file_z0-4.tif"}])
+    """
 
     normalize: bool | None = None
     sources: list[dict]
@@ -46,7 +51,7 @@ class VectorTileSource(ImageTileSource):
     """A source for vector data divided into a tile grid
 
     Note:
-        See [VectorTile](https://openlayers.org/en/latest/apidoc/module-ol_source_VectorTile-VectorTile.html)
+        See [VectorTile](https://openlayers.org/en/latest/apidoc/module-ol_source_VectorTile-VectorTile.html) for details.
     """
 
     ...
@@ -69,11 +74,15 @@ def type(self) -> str:
 # PMTiles extension
 # See https://docs.protomaps.com/pmtiles/openlayers
 class PMTilesVectorSource(Source):
+    """PMTiles vector source"""
+
     url: str
     attributions: list[str] = None
 
 
 class PMTilesRasterSource(PMTilesVectorSource):
+    """PMTiles raster source"""
+
     tile_size: tuple[int, int] = Field(None, serialization_alias="tileSize")
 
 

src/openlayers/sources.py

@@ -10,6 +10,7 @@
     VectorTileSource,
     TileJSONSource,
     PMTilesVectorSource,
+    PMTilesRasterSource,
 )
 
 __all__ = [
@@ -20,4 +21,5 @@
     "VectorTileSource",
     "TileJSONSource",
     "PMTilesVectorSource",
+    "PMTilesRasterSource",
 ]