Update 'github-pages.yaml' Workflow - Fix several warnings & enable Caching pip packages (#2539)

* Update 'github-pages.yaml' Workflow - Fix several warnings & enable Caching pip packages

* Fix 'github-pages.yaml' Syntax Error

* Make Install Dependencies step actually use the 'requirements.txt' File in 'github-pages.yaml' Workflow

* Update 'actions/setup-python' from v4 to v5 - Remove the Ignore Rule for Dependabot in '.github/dependabot.yml' File

.github/dependabot.yml

@@ -7,5 +7,3 @@ updates:
     ignore:
       - dependency-name: "actions/stale"
         versions: '>= 9'
-      - dependency-name: "actions/setup-python"
-        versions: '> 4'

.github/workflows/github-pages.yaml

@@ -1,25 +1,31 @@
 name: GitHub Pages Deploy
+
 on:
   release:
     types: [published, prereleased]
   workflow_dispatch:
+
 permissions:
   contents: write
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout Repository
-      - uses: actions/setup-python@v4
+        uses: actions/checkout@v4
         with:
-          python-version: 3.x
+          fetch-depth: '0'  # Fetch all commit history for all branches as well as tags.
-      - uses: actions/cache@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
-          key: ${{ github.ref }}
+          python-version: 3.x  # Install latest Stable release of Python 3
-          path: .cache
+          cache: 'pip'  # caching pip dependencies
-      - run: pip install mkdocs-material
+
-      - run: pip install pillow cairosvg
+      - name: Install Necessary Dependencies using 'pip install -r requirements.txt'
-      - run: pip install mkdocs-awesome-pages-plugin
+        run: pip install -r requirements.txt
-      - run: pip install mkdocs-git-revision-date-localized-plugin
+
-      - run: pip install mkdocs-minify-plugin
+      - name: Build & Deploy using 'mkdocs'
-      - run: mkdocs gh-deploy --force
+        run: mkdocs gh-deploy --force

requirements.txt

@@ -0,0 +1,51 @@
+Babel==2.15.0
+bracex==2.5
+cairocffi==1.7.1
+CairoSVG==2.7.1
+certifi==2024.7.4
+cffi==1.17.0
+charset-normalizer==3.3.2
+click==8.1.7
+colorama==0.4.6
+csscompressor==0.9.5
+cssselect2==0.7.0
+defusedxml==0.7.1
+ghp-import==2.1.0
+gitdb==4.0.11
+GitPython==3.1.43
+htmlmin2==0.1.13
+idna==3.7
+Jinja2==3.1.4
+jsmin==3.0.1
+Markdown==3.6
+MarkupSafe==2.1.5
+mergedeep==1.3.4
+mkdocs==1.6.0
+mkdocs-awesome-pages-plugin==2.9.3
+mkdocs-get-deps==0.2.0
+mkdocs-git-revision-date-localized-plugin==1.2.6
+mkdocs-material==9.5.31
+mkdocs-material-extensions==1.3.1
+mkdocs-minify-plugin==0.8.0
+natsort==8.4.0
+packaging==24.1
+paginate==0.5.6
+pathspec==0.12.1
+pillow==10.4.0
+platformdirs==4.2.2
+pycparser==2.22
+Pygments==2.18.0
+pymdown-extensions==10.9
+python-dateutil==2.9.0.post0
+pytz==2024.1
+PyYAML==6.0.2
+pyyaml_env_tag==0.1
+regex==2024.7.24
+requests==2.32.3
+six==1.16.0
+smmap==5.0.1
+tinycss2==1.3.0
+urllib3==2.2.2
+watchdog==4.0.1
+wcmatch==9.0
+webencodings==0.5.1