Skip to content

Commit 3c0f767

Browse files
authored
Improved api docs (#128)
1 parent 659cb8b commit 3c0f767

File tree

11 files changed

+223
-377
lines changed

11 files changed

+223
-377
lines changed

docs/api/layers/path-layer.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# PathLayer
2+
3+
The `PathLayer` renders lists of coordinate points as extruded polylines with mitering.
4+
5+
![](../../assets/path-layer-roads.jpg)
6+
7+
> Screenshot from North America roads example
8+
9+
::: lonboard.PathLayer
10+
options:
11+
show_bases: false
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ScatterplotLayer
2+
3+
The `ScatterplotLayer` renders circles at given coordinates.
4+
5+
![](../../assets/scatterplot-layer-network-speeds.jpg)
6+
7+
> Screenshot from Ookla example.
8+
9+
::: lonboard.ScatterplotLayer
10+
options:
11+
show_bases: false
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# SolidPolygonLayer
2+
3+
The `SolidPolygonLayer` renders filled and/or extruded polygons.
4+
5+
```py
6+
import geopandas as gpd
7+
from lonboard import SolidPolygonLayer
8+
9+
# A GeoDataFrame with Polygon geometries
10+
gdf = gpd.GeoDataFrame()
11+
layer = SolidPolygonLayer.from_geopandas(
12+
gdf,
13+
get_fill_color=[255, 0, 0],
14+
)
15+
```
16+
17+
::: lonboard.SolidPolygonLayer
18+
options:
19+
show_bases: false

docs/api/traits.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# lonboard.traits
2+
3+
::: lonboard.traits.ColorAccessor
4+
5+
::: lonboard.traits.FloatAccessor

docs/api/top-level.md renamed to docs/api/viz.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,8 @@
22

33
The top-level namespace accessible after `import lonboard`.
44

5+
Layers are also accessible in the top-level namespace, but are documented in the `layers/` folder.
6+
57
::: lonboard.viz.viz
68
options:
79
show_root_full_path: false
8-
9-
::: lonboard.ScatterplotLayer
10-
11-
::: lonboard.PathLayer
12-
13-
::: lonboard.SolidPolygonLayer

docs/layers/path-layer.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

docs/layers/scatterplot-layer.md

Lines changed: 0 additions & 152 deletions
This file was deleted.

0 commit comments

Comments
 (0)