doc: update sphinx docs

README.md

@@ -193,9 +193,9 @@ Run the command from the project root:
 # 
 cd docs && sphinx-quickstart --project SamGIS --release 1.0.0 --language python --master index
 
-# update docs folder (from project root)
-sphinx-apidoc -f -o docs samgis
-sphinx-apidoc -f -o docs samgis_core
+# update docs folder (from project root) referring to the other packages folder
+sphinx-apidoc -f -o docs /path/to/samgis_web
+sphinx-apidoc -f -o docs /path/to/samgis_core
 ```
 
 Then it's possible to generate the HTML pages

docs/Changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## Version 1.6.5
+
+- add missing files needed for HuggingFace ci
+- using samgis-core = 3.0.6, samgis-web = 1.0.8
+- updated sam-quantized submodule because of updated decoder model
+
+## Version 1.6.0
+
+- move all the helper functions to samgis_web (version 1.0.6) to avoid code duplication between different demos
+- update backend and frontend dependencies (samgis-core updated to version 3.0.5)
+- samgis_core 3.0.5 now exposes ``setup_logger()` based on `structlog` package to improve logging with correlation id
+  (that's not working with functions called from gradio interfaces)
+- SamGIS now can work using Gradio SDK on huggingface (if needed change the README.md file accordingly)
+
 ## Version 1.5.4
 
 - update backend and frontend dependencies (samgis-core updated to version 2.0.2)

docs/modules.rst

@@ -4,5 +4,5 @@ modules
 .. toctree::
    :maxdepth: 4
 
-   samgis
+   samgis_web
    samgis_core

docs/samgis.utilities.rst

@@ -1,29 +0,0 @@
-samgis.utilities package
-========================
-
-Submodules
-----------
-
-samgis.utilities.constants module
----------------------------------
-
-.. automodule:: samgis.utilities.constants
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-samgis.utilities.type\_hints module
------------------------------------
-
-.. automodule:: samgis.utilities.type_hints
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: samgis.utilities
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/samgis_core.utilities.rst

@@ -12,10 +12,10 @@ samgis\_core.utilities.constants module
    :undoc-members:
    :show-inheritance:
 
-samgis\_core.utilities.fastapi\_logger module
----------------------------------------------
+samgis\_core.utilities.create\_folders\_if\_not\_exists module
+--------------------------------------------------------------
 
-.. automodule:: samgis_core.utilities.fastapi_logger
+.. automodule:: samgis_core.utilities.create_folders_if_not_exists
    :members:
    :undoc-members:
    :show-inheritance:
@@ -36,6 +36,14 @@ samgis\_core.utilities.serialize module
    :undoc-members:
    :show-inheritance:
 
+samgis\_core.utilities.session\_logger module
+---------------------------------------------
+
+.. automodule:: samgis_core.utilities.session_logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 samgis\_core.utilities.type\_hints module
 -----------------------------------------
 

docs/samgis_web.io_package.rst

@@ -0,0 +1,45 @@
+samgis\_web.io\_package package
+===============================
+
+Submodules
+----------
+
+samgis\_web.io\_package.coordinates\_pixel\_conversion module
+-------------------------------------------------------------
+
+.. automodule:: samgis_web.io_package.coordinates_pixel_conversion
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+samgis\_web.io\_package.geo\_helpers module
+-------------------------------------------
+
+.. automodule:: samgis_web.io_package.geo_helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+samgis\_web.io\_package.raster\_helpers module
+----------------------------------------------
+
+.. automodule:: samgis_web.io_package.raster_helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+samgis\_web.io\_package.tms2geotiff module
+------------------------------------------
+
+.. automodule:: samgis_web.io_package.tms2geotiff
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: samgis_web.io_package
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/{samgis.prediction_api.rst → samgis_web.prediction_api.rst}

@@ -1,13 +1,13 @@
-samgis.prediction\_api package
-==============================
+samgis\_web.prediction\_api package
+===================================
 
 Submodules
 ----------
 
-samgis.prediction\_api.predictors module
-----------------------------------------
+samgis\_web.prediction\_api.predictors module
+---------------------------------------------
 
-.. automodule:: samgis.prediction_api.predictors
+.. automodule:: samgis_web.prediction_api.predictors
    :members:
    :undoc-members:
    :show-inheritance:
@@ -15,7 +15,7 @@ samgis.prediction\_api.predictors module
 Module contents
 ---------------
 
-.. automodule:: samgis.prediction_api
+.. automodule:: samgis_web.prediction_api
    :members:
    :undoc-members:
    :show-inheritance:

docs/{samgis.rst → samgis_web.rst}

@@ -1,5 +1,5 @@
-samgis package
-==============
+samgis\_web package
+===================
 
 Subpackages
 -----------
@@ -7,14 +7,15 @@ Subpackages
 .. toctree::
    :maxdepth: 4
 
-   samgis.io
-   samgis.prediction_api
-   samgis.utilities
+   samgis_web.io_package
+   samgis_web.prediction_api
+   samgis_web.utilities
+   samgis_web.web
 
 Module contents
 ---------------
 
-.. automodule:: samgis
+.. automodule:: samgis_web
    :members:
    :undoc-members:
    :show-inheritance:

docs/samgis_web.utilities.rst

@@ -0,0 +1,45 @@
+samgis\_web.utilities package
+=============================
+
+Submodules
+----------
+
+samgis\_web.utilities.constants module
+--------------------------------------
+
+.. automodule:: samgis_web.utilities.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+samgis\_web.utilities.frontend\_builder module
+----------------------------------------------
+
+.. automodule:: samgis_web.utilities.frontend_builder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+samgis\_web.utilities.local\_tiles\_http\_server module
+-------------------------------------------------------
+
+.. automodule:: samgis_web.utilities.local_tiles_http_server
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+samgis\_web.utilities.type\_hints module
+----------------------------------------
+
+.. automodule:: samgis_web.utilities.type_hints
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: samgis_web.utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/{samgis.io.rst → samgis_web.web.rst}

@@ -1,45 +1,37 @@
-samgis.io package
-=================
+samgis\_web.web package
+=======================
 
 Submodules
 ----------
 
-samgis.io.coordinates\_pixel\_conversion module
------------------------------------------------
+samgis\_web.web.exception\_handlers module
+------------------------------------------
 
-.. automodule:: samgis.io.coordinates_pixel_conversion
+.. automodule:: samgis_web.web.exception_handlers
    :members:
    :undoc-members:
    :show-inheritance:
 
-samgis.io.geo\_helpers module
------------------------------
+samgis\_web.web.gradio\_helpers module
+--------------------------------------
 
-.. automodule:: samgis.io.geo_helpers
+.. automodule:: samgis_web.web.gradio_helpers
    :members:
    :undoc-members:
    :show-inheritance:
 
-samgis.io.raster\_helpers module
---------------------------------
-
-.. automodule:: samgis.io.raster_helpers
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-samgis.io.tms2geotiff module
-----------------------------
+samgis\_web.web.middlewares module
+----------------------------------
 
-.. automodule:: samgis.io.tms2geotiff
+.. automodule:: samgis_web.web.middlewares
    :members:
    :undoc-members:
    :show-inheritance:
 
-samgis.io.wrappers\_helpers module
-----------------------------------
+samgis\_web.web.web\_helpers module
+-----------------------------------
 
-.. automodule:: samgis.io.wrappers_helpers
+.. automodule:: samgis_web.web.web_helpers
    :members:
    :undoc-members:
    :show-inheritance:
@@ -47,7 +39,7 @@ samgis.io.wrappers\_helpers module
 Module contents
 ---------------
 
-.. automodule:: samgis.io
+.. automodule:: samgis_web.web
    :members:
    :undoc-members:
    :show-inheritance: