diff --git a/MANIFEST.in b/MANIFEST.in index e8e2eba7..792b9738 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -5,4 +5,4 @@ include requirements_dev.txt recursive-exclude * __pycache__ -exclude .git/* .idea/* docs/* .github/* joss/* tests/* \ No newline at end of file +exclude .git/* .idea/* docs/** .github/* joss/** tests/* \ No newline at end of file diff --git a/docs/getting_started/gemgis.rst b/docs/getting_started/gemgis.rst new file mode 100644 index 00000000..7dd5d3e5 --- /dev/null +++ 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 index 12c0955e..df352a59 100644 --- 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 new file mode 100644 index 00000000..d57ec510 --- /dev/null +++ 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 index 37c32b79..4122b8d6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,6 +34,7 @@ GemGIS uses and combines the full functionality of `GeoPandas