Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev gemgis2 #315

Merged
merged 3 commits into from
Nov 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -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/*
84 changes: 84 additions & 0 deletions docs/getting_started/gemgis.rst
Original file line number Diff line number Diff line change
@@ -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:
2 changes: 1 addition & 1 deletion docs/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Index
example/index

api
reference/index
modules
7 changes: 7 additions & 0 deletions docs/getting_started/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
GemGIS API Reference
====================

.. toctree::
:maxdepth: 4

gemgis
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==================
Expand Down