Merge pull request #315 from cgre-aachen/dev_gemgis2

Dev gemgis2
cgre-aachen · Nov 11, 2023 · 4274e45 · 4274e45
2 parents 0d2d30f + b9a16be
commit 4274e45
Show file tree

Hide file tree

Showing 5 changed files with 94 additions and 2 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -5,4 +5,4 @@ include requirements_dev.txt
 
 recursive-exclude * __pycache__
 
-exclude .git/* .idea/* docs/* .github/* joss/* tests/*
+exclude .git/* .idea/* docs/** .github/* joss/** tests/*
diff --git a/docs/getting_started/gemgis.rst b/docs/getting_started/gemgis.rst
@@ -0,0 +1,84 @@
+GemGIS API Reference
+====================
+
+The API reference provides an overview of all functions and methods implemented in GemGIS.
+
+gemgis.download\_gemgis\_data module
+------------------------------------
+
+.. automodule:: gemgis.download_gemgis_data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gemgis.gemgis module
+--------------------
+
+.. automodule:: gemgis.gemgis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gemgis.misc module
+------------------
+
+.. automodule:: gemgis.misc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gemgis.postprocessing module
+----------------------------
+
+.. automodule:: gemgis.postprocessing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gemgis.raster module
+--------------------
+
+.. automodule:: gemgis.raster
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gemgis.utils module
+-------------------
+
+.. automodule:: gemgis.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gemgis.vector module
+--------------------
+
+.. automodule:: gemgis.vector
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gemgis.visualization module
+---------------------------
+
+.. automodule:: gemgis.visualization
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gemgis.web module
+-----------------
+
+.. automodule:: gemgis.web
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: gemgis
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst
@@ -20,4 +20,4 @@ Index
    example/index
 
    api
-   reference/index
+   modules
diff --git a/docs/getting_started/modules.rst b/docs/getting_started/modules.rst
@@ -0,0 +1,7 @@
+GemGIS API Reference
+====================
+
+.. toctree::
+   :maxdepth: 4
+
+   gemgis
diff --git a/docs/index.rst b/docs/index.rst
@@ -34,6 +34,7 @@ GemGIS uses and combines the full functionality of `GeoPandas <https://geopandas
    getting_started/example/index
 
    getting_started/api
+   getting_started/modules
 
 Indices and tables
 ==================