comment out generate-docs

Author: joshjennings98

.github/workflows/ci.yml

@@ -47,47 +47,47 @@ jobs:
           echo "::error:: News file missing (See CONTRIBUTING.md guide for details)."
 
 
-  generate-docs:
-    name: Build Documentation
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: ${{ env.python_version}}
-      - name: Determine dependencies
-        # Note
-        # The below code generates a pip requirements file from the pipenv development requirements (also obtaining the
-        # normal dependencies from setup.py).
-        # This code also forces the system to install latest tools as the ones present on the CI system may be too old
-        # for the process to go through properly.
-        # FIXME upgrade pipenv when https://github.com/pypa/pipenv/issues/4430 is actually fixed
-        run: |
-          python -m pip install --upgrade pip wheel setuptools
-          python -m pip install pipenv==${{ env.pipenv_version }}
-          echo "Locking dependencies"
-          python -m pipenv lock
-          python -m pipenv requirements > dev-requirements.txt
-      - uses: FranzDiebold/github-env-vars-action@v2
-      - name: Load Python Dependencies from cache
-        uses: actions/cache@v4
-        with:
-          path: ${{ env.python_cache_ubuntu_path }}
-          key:  linux-pip-3-continuous-delivery-scripts
-      - name: Install dependencies
-        # Note
-        # As a virtual machine is already being used, pipenv
-        # is superfluous and eliminating pipenv in CI reduces overhead and reduce complexity, while retaining a single
-        # location for development dependencies.
-        run: |
-          python -m pip install -r dev-requirements.txt
-          python -m pip list
-      - name: Generate Documentation
-        run: |
-          cd-generate-docs --output_dir $(cd-get-config --key DOCUMENTATION_PRODUCTION_OUTPUT_PATH)
-      - name: Add copyright/licence notice.
-        run: |
-          cd-license-files
+  # generate-docs:
+  #   name: Build Documentation
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - uses: actions/setup-python@v5
+  #       with:
+  #         python-version: ${{ env.python_version}}
+  #     - name: Determine dependencies
+  #       # Note
+  #       # The below code generates a pip requirements file from the pipenv development requirements (also obtaining the
+  #       # normal dependencies from setup.py).
+  #       # This code also forces the system to install latest tools as the ones present on the CI system may be too old
+  #       # for the process to go through properly.
+  #       # FIXME upgrade pipenv when https://github.com/pypa/pipenv/issues/4430 is actually fixed
+  #       run: |
+  #         python -m pip install --upgrade pip wheel setuptools
+  #         python -m pip install pipenv==${{ env.pipenv_version }}
+  #         echo "Locking dependencies"
+  #         python -m pipenv lock
+  #         python -m pipenv requirements > dev-requirements.txt
+  #     - uses: FranzDiebold/github-env-vars-action@v2
+  #     - name: Load Python Dependencies from cache
+  #       uses: actions/cache@v4
+  #       with:
+  #         path: ${{ env.python_cache_ubuntu_path }}
+  #         key:  linux-pip-3-continuous-delivery-scripts
+  #     - name: Install dependencies
+  #       # Note
+  #       # As a virtual machine is already being used, pipenv
+  #       # is superfluous and eliminating pipenv in CI reduces overhead and reduce complexity, while retaining a single
+  #       # location for development dependencies.
+  #       run: |
+  #         python -m pip install -r dev-requirements.txt
+  #         python -m pip list
+  #     - name: Generate Documentation
+  #       run: |
+  #         cd-generate-docs --output_dir $(cd-get-config --key DOCUMENTATION_PRODUCTION_OUTPUT_PATH)
+  #     - name: Add copyright/licence notice.
+  #       run: |
+  #         cd-license-files
 
   tpip:
     name: Report licences in use (SPDX)