Skip to content

Commit b0f594a

Browse files
authored
Update english api (#59)
* update api * rename top_level_functions * add layer functions * update plot api name * add en api
1 parent 737686c commit b0f594a

File tree

6 files changed

+47
-9
lines changed

6 files changed

+47
-9
lines changed

doc-cn/create_html.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def replace(source_api_path):
5555
replace("build/html/feature_description/visualization/")
5656
replace("build/html/api_reference/")
5757
replace("build/html/api_reference/cluster_api")
58-
replace("build/html/api_reference/map_match")
58+
replace("build/html/api_reference/top_level_functions")
5959
replace("build/html/api_reference/plot")
6060
replace("build/html/api_reference/standalone_api")
6161
ignore_python_prompt()

doc-en/compile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def replace(source_api_path):
5555
replace("build/html/feature_description/visualization/")
5656
replace("build/html/api_reference/")
5757
replace("build/html/api_reference/cluster_api")
58-
replace("build/html/api_reference/map_match")
58+
replace("build/html/api_reference/top_level_functions")
5959
replace("build/html/api_reference/plot")
6060
replace("build/html/api_reference/standalone_api")
6161
ignore_python_prompt()

doc-en/source/api_reference/api_reference.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ API Reference
77
:maxdepth: 1
88

99
standalone_api/geoseries
10-
cluster_api/cluster_api
11-
map_match/map_match
12-
plot/plot
10+
standalone_api/geodataframe
11+
top_level_functions/top_level_functions
12+
plot/plot

doc-en/source/api_reference/plot/plot.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,10 @@ Plot
1212
arctern.plot.heatmap
1313
arctern.plot.choroplethmap
1414
arctern.plot.iconviz
15-
arctern.plot.fishnetmap
15+
arctern.plot.fishnetmap
16+
arctern.plot.pointmap_layer
17+
arctern.plot.weighted_pointmap_layer
18+
arctern.plot.heatmap_layer
19+
arctern.plot.choroplethmap_layer
20+
arctern.plot.iconviz_layer
21+
arctern.plot.fishnetmap_layer
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. _geodataframe:
2+
3+
GeoDataFrame
4+
=========
5+
.. currentmodule:: arctern
6+
7+
GeoDataFrame inherits pandas DataFrame. It is a DataFrame to store and process geometric data.
8+
9+
Constructor
10+
-----------
11+
.. autosummary::
12+
:toctree: api/
13+
:template: autosummaryclass.rst
14+
15+
GeoDataFrame
16+
17+
GeoDataFrame Functions
18+
---------------------
19+
.. autosummary::
20+
:toctree: api/
21+
22+
GeoDataFrame.to_geopandas
23+
GeoDataFrame.from_geopandas
24+
GeoDataFrame.to_json
25+
GeoDataFrame.from_file
26+
GeoDataFrame.to_file
27+
GeoDataFrame.crs
28+
GeoDataFrame.set_geometry
29+
GeoDataFrame.dissolve
30+
GeoDataFrame.merge

doc-en/source/api_reference/map_match/map_match.rst renamed to doc-en/source/api_reference/top_level_functions/top_level_functions.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.. _map_match:
1+
.. _top_level_functions:
22

3-
Map Match
3+
Top Level Functions
44
==========
55

66
.. autosummary::
@@ -9,4 +9,6 @@ Map Match
99
arctern.nearest_location_on_road
1010
arctern.nearest_road
1111
arctern.near_road
12-
arctern.within_which
12+
arctern.within_which
13+
arctern.sjoin
14+
arctern.read_file

0 commit comments

Comments
 (0)