update geojson docs

UTokyo-FieldPhenomics-Lab · Jan 5, 2024 · 2cd061c · 2cd061c
1 parent 46aeea5
commit 2cd061c
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 2 deletions.
diff --git a/docs/python_api/autodoc/easyidp.jsonfile.read_geojson.rst b/docs/python_api/autodoc/easyidp.jsonfile.read_geojson.rst
@@ -0,0 +1,6 @@
+easyidp.jsonfile.read\_geojson
+==============================
+
+.. currentmodule:: easyidp.jsonfile
+
+.. autofunction:: read_geojson
diff --git a/docs/python_api/autodoc/easyidp.jsonfile.show_geojson_fields.rst b/docs/python_api/autodoc/easyidp.jsonfile.show_geojson_fields.rst
@@ -0,0 +1,6 @@
+easyidp.jsonfile.show\_geojson\_fields
+======================================
+
+.. currentmodule:: easyidp.jsonfile
+
+.. autofunction:: show_geojson_fields
diff --git a/docs/python_api/index.rst b/docs/python_api/index.rst
@@ -13,7 +13,7 @@ The EasyIDP package have the following modules:
 - :doc:`ROI Module <./roi>` : read region of interest from shp and txt file.
 
   - :doc:`shp Submodule <./shp>`: read shape (\*.shp) file.
-  - :doc:`jsonfile Submodule <./json>`: read and write json file.
+  - :doc:`jsonfile Submodule <./json>`: read and write json and geojson file.
   - :doc:`geotools Submodule <./geotools>`: transform geo-coordinate.
 
 - :doc:`reconstruct Module <./reconstruct>` : process 3D reconstruction software project.

diff --git a/docs/python_api/json.rst b/docs/python_api/json.rst
@@ -22,6 +22,8 @@ Functions
     :toctree: autodoc
 
     read_json
+    read_geojson
+    show_geojson_fields
     dict2json
     write_json
     save_json
diff --git a/easyidp/shp.py b/easyidp/shp.py
@@ -63,7 +63,7 @@ def read_proj(prj_path):
 
 def show_shp_fields(shp_path, encoding="utf-8"):
     """
-    Read shp field data to pandas.DataFrame, for further json metadata usage
+    Show geojson properties data, for better setting ``name_field`` of :py:obj:`read_shp <easyidp.roi.ROI.read_shp>`
     
     Parameters
     ----------