Improve SeBS documentation

.readthedocs.yaml

@@ -0,0 +1,28 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python: 
+  install:
+    - requirements: requirements.docs.txt
+    - requirements: requirements.txt
+    - requirements: requirements.aws.txt
+    - requirements: requirements.azure.txt
+    - requirements: requirements.gcp.txt
+    - requirements: requirements.local.txt
+

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     = source
+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/source/api/modules.rst

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

docs/source/api/sebs.aws.rst

@@ -0,0 +1,89 @@
+sebs.aws package
+================
+
+.. contents:: Table of Contents
+   :local:
+   :depth: 2
+
+Submodules
+----------
+
+sebs.aws.aws module
+-------------------
+
+.. automodule:: sebs.aws.aws
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.aws.config module
+----------------------
+
+.. automodule:: sebs.aws.config
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.aws.container module
+-------------------------
+
+.. automodule:: sebs.aws.container
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.aws.dynamodb module
+------------------------
+
+.. automodule:: sebs.aws.dynamodb
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.aws.function module
+------------------------
+
+.. automodule:: sebs.aws.function
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.aws.resources module
+-------------------------
+
+.. automodule:: sebs.aws.resources
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.aws.s3 module
+------------------
+
+.. automodule:: sebs.aws.s3
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.aws.triggers module
+------------------------
+
+.. automodule:: sebs.aws.triggers
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+Module contents
+---------------
+
+.. automodule:: sebs.aws
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/source/api/sebs.azure.rst

@@ -0,0 +1,98 @@
+sebs.azure package
+==================
+
+.. contents:: Table of Contents
+   :local:
+   :depth: 2
+
+Submodules
+----------
+
+sebs.azure.azure module
+-----------------------
+
+.. automodule:: sebs.azure.azure
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.azure.blob\_storage module
+-------------------------------
+
+.. automodule:: sebs.azure.blob_storage
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.azure.cli module
+---------------------
+
+.. automodule:: sebs.azure.cli
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.azure.cloud\_resources module
+----------------------------------
+
+.. automodule:: sebs.azure.cloud_resources
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.azure.config module
+------------------------
+
+.. automodule:: sebs.azure.config
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.azure.cosmosdb module
+--------------------------
+
+.. automodule:: sebs.azure.cosmosdb
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.azure.function module
+--------------------------
+
+.. automodule:: sebs.azure.function
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.azure.system\_resources module
+-----------------------------------
+
+.. automodule:: sebs.azure.system_resources
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.azure.triggers module
+--------------------------
+
+.. automodule:: sebs.azure.triggers
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+Module contents
+---------------
+
+.. automodule:: sebs.azure
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/source/api/sebs.experiments.rst

@@ -0,0 +1,98 @@
+sebs.experiments package
+========================
+
+.. contents:: Table of Contents
+   :local:
+   :depth: 2
+
+Submodules
+----------
+
+sebs.experiments.config module
+------------------------------
+
+.. automodule:: sebs.experiments.config
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.experiments.environment module
+-----------------------------------
+
+.. automodule:: sebs.experiments.environment
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.experiments.eviction\_model module
+---------------------------------------
+
+.. automodule:: sebs.experiments.eviction_model
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.experiments.experiment module
+----------------------------------
+
+.. automodule:: sebs.experiments.experiment
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.experiments.invocation\_overhead module
+--------------------------------------------
+
+.. automodule:: sebs.experiments.invocation_overhead
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.experiments.network\_ping\_pong module
+-------------------------------------------
+
+.. automodule:: sebs.experiments.network_ping_pong
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.experiments.perf\_cost module
+----------------------------------
+
+.. automodule:: sebs.experiments.perf_cost
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.experiments.result module
+------------------------------
+
+.. automodule:: sebs.experiments.result
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+sebs.experiments.startup\_time module
+-------------------------------------
+
+.. automodule:: sebs.experiments.startup_time
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :no-index:
+
+Module contents
+---------------
+
+.. automodule:: sebs.experiments
+   :members:
+   :show-inheritance:
+   :undoc-members: