Remove sphinx-multiversion

Author: jb3

.github/workflows/docs.yaml

@@ -5,7 +5,7 @@ on:
   workflow_call:
 
 jobs:
-  latest-build:
+  build-deploy:
     # We only need to verify that the docs build with no warnings here
     name: Build Latest Docs Version
     runs-on: ubuntu-latest
@@ -28,38 +28,6 @@ jobs:
           name: docs-latest
           path: docs/build/*
 
-  build-deploy:
-    name: Build & Deploy Docs
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0 # We need to check out the entire repository to find all tags
-
-      - name: Install Python Dependencies
-        uses: HassanAbouelela/actions/setup-python@setup-python_v1.4.2
-        with:
-          python_version: "3.12"
-          install_args: "--extras async-rediscache"
-
-      - name: Build All Doc Versions
-        run: sphinx-multiversion docs docs/build -n -j auto
-        env:
-          BUILD_DOCS_FOR_HEAD: ${{ github.event_name == 'pull_request' }}
-          BRANCH_NAME: ${{ github.head_ref }}
-
-      - name: Remove Metadata Files
-        run: |
-          rm -r docs/build/**/_sources
-          rm -r docs/build/**/.doctrees
-
-      - name: Upload Build Artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: docs
-          path: docs/build/*
-
       - name: Deploy To GitHub Pages
         uses: JamesIves/github-pages-deploy-action@v4
         with:

docs/README.md

@@ -36,28 +36,6 @@ The docs folder has a few moving components, here's a brief description of each:
 - `utils.py`: Helpful function used by `conf.py` to properly create the docs.
 - `netlify_build.py`: Script which downloads the build output in netlify. Refer to [Static Netlify Build](#static-builds)
 
-
-## Versions
-The project supports building all different versions at once using [sphinx-multiversion][multiversion]
-after version `v7.1.0`. You can run the following command to achieve that:
-
-```shell
-poetry run sphinx_multiversion -v docs docs/build -n -j auto -n
-```
-
-This will build all tags, as well as the main branch. To build branches besides the main one
-(such as the one you are currently working on), set the `BUILD_DOCS_FOR_HEAD` environment variable
-to True.
-
-When using multi-version, keep the following in mind:
-1. This command will not fail on warnings, unlike the docs task. Make sure that passes first
-   before using this one.
-2. Make sure to clear the build directory before running this script to avoid conflicts.
-
-
-[multiversion]: https://holzhaus.github.io/sphinx-multiversion/master/index.html
-
-
 ## Docstrings
 To have your code properly added to the generated docs, you need to do a couple of things:
 1. Write your code with annotations.

docs/conf.py

@@ -53,7 +53,6 @@
     "releases",
     "sphinx.ext.linkcode",
     "sphinx.ext.githubpages",
-    "sphinx_multiversion",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -224,22 +223,3 @@ def _releases_setup(app: Sphinx) -> dict:
 
 _original_releases_setup = releases.setup
 releases.setup = _releases_setup
-
-
-# -- Options for the multiversion extension ----------------------------------
-# Filter out older versions, and don't build branches other than main
-# unless `BUILD_DOCS_FOR_HEAD` env variable is True.
-smv_remote_whitelist = "origin"
-smv_latest_version = "main"
-
-smv_branch_whitelist = "main"
-if os.getenv("BUILD_DOCS_FOR_HEAD", "False").lower() == "true":
-    if not (branch := os.getenv("BRANCH_NAME")):
-        with contextlib.suppress(git.InvalidGitRepositoryError):
-            branch = git.Repo(PROJECT_ROOT).active_branch.name
-
-    if branch:
-        logger.info(f"Adding branch {branch} to build whitelist.")
-        smv_branch_whitelist = f"main|{branch}"
-
-smv_tag_whitelist = r"v(?!([0-6]\.)|(7\.[0-1]\.0))"  # Don't include any versions prior to v7.1.1