Deploying Sphinx docs to the GitHub Pages

Author: Priyatham10

.github/workflows/sphinx-build.yaml

@@ -0,0 +1,29 @@
+name: Docs
+on: 
+  # Manual run
+  workflow_dispatch:
+permissions:
+    contents: write
+jobs:
+  docs:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme
+          pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
+          pip install --exists-action=w --no-cache-dir -r docs/rtd-requirements.txt
+      - name: Sphinx build
+        run: |
+          sphinx-build docs/source _build
+          dir
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        # if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true          

.gitignore

@@ -6,4 +6,5 @@
 *.res
 *.rc
 \__pycache__
-\__history
+\__history
+_build/

.readthedocs.yaml

@@ -0,0 +1,13 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all