Update docs

Author: stfnkth

examples/standalone/layers/tilejson_layer.py

@@ -3,7 +3,7 @@
 import openlayers as ol
 
 layer = ol.TileLayer(
-    source=ol.TileJSON(
+    source=ol.TileJSONSource(
         url="https://maps.gnosis.earth/ogcapi/collections/NaturalEarth:raster:HYP_HR_SR_OB_DR/map/tiles/WebMercatorQuad?f=tilejson"
     )
 )

src/openlayers/models/sources.py

@@ -12,33 +12,59 @@ class Source(OLBaseModel): ...
 
 # --- Sources
 class VectorSource(Source):
+    """Vector source"""
+
     url: str | None = None
     # features: list[dict] | None = None
     geojson: dict | None = Field(None, serialization_alias="@@geojson")
     format: FormatT | dict = GeoJSON()
 
 
-class OSM(Source): ...
+class OSM(Source):
+    """OSM source"""
+
+    ...
 
 
 class GeoTIFFSource(Source):
+    """GeoTIFF source"""
+
     normalize: bool | None = None
     sources: list[dict]
 
 
 class ImageTileSource(Source):
+    """Image tile source"""
+
     url: str
     attributions: str | None = None
     min_zoom: float | int | None = Field(0, serialization_alias="minZoom")
     max_zoom: float | int | None = Field(20, serialization_alias="maxZoom")
 
 
-class VectorTileSource(ImageTileSource): ...
+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)
+    """
 
+    ...
+
+
+class TileJSONSource(ImageTileSource):
+    """A source for tile data in TileJSON format
+
+    Note:
+        See [TileJSON](https://openlayers.org/en/latest/apidoc/module-ol_source_TileJSON-TileJSON.html) for details.
+    """
 
-class TileJSON(ImageTileSource):
     cross_origin: str = Field("anonymous", serialization_alias="crossOrigin")
 
+    @property
+    def type(self) -> str:
+        return "TileJSON"
+
 
 # PMTiles extension
 # See https://docs.protomaps.com/pmtiles/openlayers
@@ -58,7 +84,7 @@ class PMTilesRasterSource(PMTilesVectorSource):
     GeoTIFFSource,
     ImageTileSource,
     ImageTileSource,
-    TileJSON,
+    TileJSONSource,
     PMTilesVectorSource,
     PMTilesRasterSource,
 ]

src/openlayers/sources.py

@@ -8,7 +8,7 @@
     SourceT,
     VectorSource,
     VectorTileSource,
-    TileJSON,
+    TileJSONSource,
     PMTilesVectorSource,
 )
 
@@ -18,6 +18,6 @@
     "VectorSource",
     "ImageTileSource",
     "VectorTileSource",
-    "TileJSON",
+    "TileJSONSource",
     "PMTilesVectorSource",
 ]