[docs] add first working sphinx docs build

README.md

@@ -1,4 +1,4 @@
-# Segment Geospatial
+# SamGIS
 
 ## todo
 
@@ -63,3 +63,25 @@ Tests are defined in the `tests` folder in this project. Use PIP to install the
 ```bash
 python -m pytest --cov=src --cov-report=term-missing && coverage html
 ```
+
+## Update the static documentation with sphinx
+
+Run the sphinx-apidoc: it's a tool for automatic generation of Sphinx sources that, using the autodoc
+extension, document a whole package in the style of other automatic API documentation tools. See the 
+[documentation page](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html) for details.
+Run the command from the project root:
+
+```bash
+# missing docs folder
+sphinx-quickstart -p SamGIS -a "alessandro trinca tornidor" -r 1.0.0 -l python --master index
+
+# update docs folder
+sphinx-apidoc -f -o docs src
+```
+
+Then it's possible to generate the HTML pages 
+```bash
+cd docs && make html
+```
+
+The static documentation it's now ready at the path `_build/html/index.html`.

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,70 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+
+project = 'SamGIS'
+copyright = '2023, alessandro trinca tornidor'
+author = 'alessandro trinca tornidor'
+release = '1.0.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+sys.path.insert(0, os.path.abspath('..'))
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+    # 'sphinx_autodoc_defaultargs'
+]
+# Napoleon settings
+napoleon_google_docstring = True
+# napoleon_include_init_with_doc = False
+# napoleon_include_private_with_doc = False
+# napoleon_include_special_with_doc = True
+# napoleon_use_admonition_for_examples = False
+# napoleon_use_admonition_for_notes = False
+# napoleon_use_admonition_for_references = False
+# napoleon_use_ivar = False
+# napoleon_use_param = True
+# napoleon_use_rtype = True
+# napoleon_preprocess_types = False
+# napoleon_type_aliases = None
+# napoleon_attr_annotations = True
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'build/*']
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+# default args values
+rst_prolog = """
+.. |default| raw:: html
+
+    <div class="default-value-section">""" + \
+    ' <span class="default-value-label">Default:</span>'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,20 @@
+.. SamGIS documentation master file, created by
+   sphinx-quickstart on Thu Nov 23 21:51:08 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to SamGIS's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/modules.rst

@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   src

docs/src.prediction_api.rst

@@ -0,0 +1,29 @@
+src.prediction\_api package
+===========================
+
+Submodules
+----------
+
+src.prediction\_api.predictors module
+-------------------------------------
+
+.. automodule:: src.prediction_api.predictors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+src.prediction\_api.sam\_onnx module
+------------------------------------
+
+.. automodule:: src.prediction_api.sam_onnx
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: src.prediction_api
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/src.rst

@@ -0,0 +1,30 @@
+src package
+===========
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   src.prediction_api
+   src.utilities
+
+Submodules
+----------
+
+src.app module
+--------------
+
+.. automodule:: src.app
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: src
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/src.utilities.rst

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

requirements_docs.txt

@@ -0,0 +1 @@
+sphinx

src/__init__.py

@@ -1,3 +1,4 @@
+"""Get machine learning predictions from geodata raster images"""
 from aws_lambda_powertools import Logger
 import os
 from pathlib import Path

src/app.py

@@ -1,3 +1,4 @@
+"""Lambda entry point"""
 import time
 from http import HTTPStatus
 
@@ -10,6 +11,17 @@ from src.prediction_api.predictors import samexporter_predict
 
 
 def lambda_handler(event: dict, context: LambdaContext):
+    """
+    Handle the request for the serverless backend, dispatch the response.
+
+    Args:
+        event: request content
+        context: request context
+
+    Returns:
+        dict: response from try_return_output() function
+
+    """
     app_logger.info(f"start with aws_request_id:{context.aws_request_id}.")
     start_time = time.time()