Skip to content

Commit 9a4a744

Browse files
committed
Update docs
1 parent 6143ccd commit 9a4a744

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

docs/api/basemaps.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
docstring_section_style: list
44

55
::: maplibre.basemaps.OpenFreeMap
6+
options:
7+
docstring_section_style: list
68

79
::: maplibre.basemaps.MapTiler
810
options:

maplibre/basemaps.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,16 @@ def background(color: str = "black", opacity: float = 1.0) -> dict:
6161

6262

6363
class MapTiler(Enum):
64-
"""MapTiler basemap styles"""
64+
"""MapTiler basemap styles
65+
66+
Examples:
67+
>>> import os
68+
>>> from maplibre import Map, MapOptions
69+
>>> from maplibre.basemaps import MapTiler
70+
71+
>>> os.environ["MAPTILER_API_KEY"] = "your-api-key"
72+
>>> m = Map(MapOptions(style=MapTiler.AQUARELLE))
73+
"""
6574

6675
AQUARELLE = "aquarelle"
6776
BACKDROP = "backdrop"

poetry.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)