run sphinxs workflow on main

Author: giograno

.github/workflows/docs.yml

@@ -1,6 +1,12 @@
 name: Build sphinx documentation
 
-on: workflow_dispatch
+on:
+  push:
+    paths:
+      - 'docs/**'
+    branches:
+      - main
+  workflow_dispatch:
 
 jobs:
   build:
@@ -32,4 +38,4 @@ jobs:
       if: github.ref == 'refs/heads/main'
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: docs/_build/html
+        publish_dir: docs/_build/html

docs/conf.py

@@ -8,18 +8,19 @@
 
 import os
 import sys
+
 sys.path.insert(0, os.path.abspath("../localstack-sdk-python/localstack"))
 
 
 def _get_version() -> str:
-    with open(os.path.abspath("../VERSION"), 'r') as f:
+    with open(os.path.abspath("../VERSION"), "r") as f:
         version = f.read()
         return version
 
 
-project = 'LocalStack Python SDK'
-copyright = '2024, LocalStack Team'
-author = 'LocalStack Team'
+project = "LocalStack Python SDK"
+copyright = "2024, LocalStack Team"
+author = "LocalStack Team"
 release = _get_version()
 
 # -- General configuration ---------------------------------------------------
@@ -28,31 +29,31 @@ def _get_version() -> str:
 # enable auto-doc extension
 extensions = ["sphinx.ext.autodoc"]
 
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
-html_static_path = ['_static']
+html_theme = "alabaster"
+html_static_path = ["_static"]
 
 html_sidebars = {
-    '**': [
-        'about.html',
-        'searchfield.html',
-        'navigation.html',
+    "**": [
+        "about.html",
+        "searchfield.html",
+        "navigation.html",
     ]
 }
 
 html_theme_options = {
-    'extra_nav_links': {
-        'Source': 'https://github.com/localstack/localstack-sdk-python',
-        'Issues': 'https://github.com/localstack/localstack-sdk-python/issues',
-        'PyPI': 'https://pypi.org/project/localstack-sdk-python/',
+    "extra_nav_links": {
+        "Source": "https://github.com/localstack/localstack-sdk-python",
+        "Issues": "https://github.com/localstack/localstack-sdk-python/issues",
+        "PyPI": "https://pypi.org/project/localstack-sdk-python/",
     },
-    'description': 'Python SDK to interact with LocalStack developer endpoints',
-    'github_user': 'localstack',
-    'github_repo': 'localstack-sdk-python'
+    "description": "Python SDK to interact with LocalStack developer endpoints",
+    "github_user": "localstack",
+    "github_repo": "localstack-sdk-python",
 }