Skip to content

Commit db0ec28

Browse files
committed
docs: add api docs, plus ensure voronoi img in mkdocs
1 parent 8a1700c commit db0ec28

File tree

2 files changed

+26
-2
lines changed

2 files changed

+26
-2
lines changed

docs/api.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,29 @@
11
# API Docs
22

3-
<!-- ::: pg_nearest_city.reverse_geocode.city_from_geopoint
3+
## Async Reverse Geocode
4+
5+
::: pg_nearest_city.AsyncNearestCity
6+
options:
7+
show_source: false
8+
heading_level: 3
9+
10+
## Sync Reverse Geocode
11+
12+
::: pg_nearest_city.NearestCity
13+
options:
14+
show_source: false
15+
heading_level: 3
16+
17+
## Query Output
18+
19+
::: pg_nearest_city.Location
20+
options:
21+
show_source: false
22+
heading_level: 3
23+
24+
## Database Configuration
25+
26+
::: pg_nearest_city.DbConfig
427
options:
528
show_source: false
6-
heading_level: 3 -->
29+
heading_level: 3

docs/voronoi_italy.jpg

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../voronoi_italy.jpg

0 commit comments

Comments
 (0)