adding workflow

Author: TLSDC

.github/workflows/readthedocs.yml

@@ -0,0 +1,46 @@
+name: Update Docs with Versioning
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.x
+
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install sphinx
+
+    - name: Run Sphinx-apidoc
+      run: |
+        cd docs
+        sphinx-apidoc ../src -o ./source
+
+    - name: Commit and Push to Generated Docs Branch
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        git config --global user.name "github-actions[bot]"
+        git config --global user.email "github-actions[bot]@users.noreply.github.com"
+        git checkout -b generated-docs || git checkout generated-docs
+        git add .
+        git commit -m "Update docs for version $GITHUB_REF_NAME [skip ci]" || echo "No changes to commit"
+        git push origin generated-docs

.readthedocs.yaml

@@ -2,7 +2,8 @@
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
 # Required
-version: 2
+version:
+  type: tag
 
 # Set the OS, Python version and other tools you might need
 build: