Add support for GH-Pages (#159)

exasol · Dec 5, 2024 · ed41520 · ed41520
1 parent ad228bd
commit ed41520
Show file tree

Hide file tree

Showing 23 changed files with 45 additions and 1,746 deletions.
diff --git a/.github/workflows/ci-master.yml b/.github/workflows/ci-master.yml
@@ -18,3 +18,7 @@ jobs:
 
   ssl_cert:
     uses: ./.github/workflows/ssl_cert.yml
+
+  publish-docs:
+    name: Publish Documentation
+    uses: ./.github/workflows/gh-pages.yml
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -0,0 +1,32 @@
+name: Publish Documentation                                                                  
+
+on:                                                                                          
+  workflow_call:                                                                             
+  workflow_dispatch:                                                                         
+
+jobs:                                                                                        
+
+  documentation-job:                                                                         
+    runs-on: ubuntu-latest                                                                   
+
+    steps:                                                                                   
+      - name: SCM Checkout                                                                   
+        uses: actions/checkout@v4                                                            
+        with:                                                                                
+          fetch-depth: 0                                                                     
+
+      - name: Setup Python & Poetry Environment                                              
+        uses: exasol/python-toolbox/.github/actions/[email protected]                
+
+      - name: Build Documentation                                                            
+        run: |                                                                               
+          poetry run nox -s docs:multiversion                                                
+                                                                                             
+      - name: Deploy                                                                         
+        uses: JamesIves/[email protected]                                    
+        with:                                                                                
+          branch: gh-pages                                                                   
+          folder: .html-documentation                                                        
+          git-config-name: Github Action                                                     
+          git-config-email: [email protected]                                            
+
diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md
@@ -1,6 +1,13 @@
 # Unreleased
 
+## ✨Features
+
+* Add support for multiversion documentation
+
+## 🔩 Internal
+
+* Add support for publishing documentation to gh pages
+
 ## 📚 Documentation
 
 * Add sphinx based documention
-
diff --git a/docs/BEST_PRACTICES.md b/docs/BEST_PRACTICES.md
diff --git a/docs/DBAPI_COMPAT.md b/docs/DBAPI_COMPAT.md
diff --git a/docs/DEPENDENCIES.md b/docs/DEPENDENCIES.md
diff --git a/docs/DESIGN.md b/docs/DESIGN.md
diff --git a/docs/DEVELOPER_GUIDE.md b/docs/DEVELOPER_GUIDE.md
diff --git a/docs/ENCRYPTION.md b/docs/ENCRYPTION.md