add autodoc

docs/source/aws.rst

@@ -49,3 +49,9 @@ The ``AWS`` class provides methods to interact with Amazon Web Services (AWS) S3
 
          aws_client = AWS('your-access-key-id', 'your-secret-access-key', 'us-east-1')
          aws_client.download_data('my-s3-bucket', 'path/in/bucket/file.txt', '/local/path/to/save/file.txt')
+
+
+.. automodule:: aws
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/conf.py

@@ -7,6 +7,13 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 # import pydata_sphinx_theme
 
+import os
+import sys
+
+# for the auto documentation to work
+sys.path.insert(0, os.path.abspath("../../src/unicloud"))
+
+
 project = "unicloud"
 copyright = "2024, Mostafa Farrag"
 author = "Mostafa Farrag"
@@ -15,14 +22,15 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = [
+    "sphinx.ext.autodoc",
+]
 
 templates_path = ["_templates"]
 exclude_patterns = []
 
 root_doc = "index"
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

docs/source/gcs.rst

@@ -43,3 +43,8 @@ The ``GCS`` class provides methods to interact with Google Cloud Storage (GCS),
 
          gcs_client = GCS('my-gcp-project')
          gcs_client.download_data('bucket-name/object-name.txt', '/local/path/to/save/file.txt')
+
+.. automodule:: gcs
+   :members:
+   :undoc-members:
+   :show-inheritance: