Remove versioned docs (#616)

* remove sphinx multiversion * remove smv options * remove sphinx_multiversion from conf.py
bambinos · Dec 22, 2022 · ac8f720 · ac8f720
1 parent ced76a5
commit ac8f720
Show file tree

Hide file tree

Showing 6 changed files with 3 additions and 33 deletions.
diff --git a/.github/workflows/publish-docs-release.yml b/.github/workflows/publish-docs-release.yml
@@ -42,9 +42,8 @@ jobs:
       - name: Remove and build documentation from scratch
         run: |
           rm -rd docs/_build/html
-          sphinx-multiversion docs docs/_build/html
+          sphinx-build docs docs/_build/html
           touch docs/_build/html/.nojekyll
-          cp docs/_assets/gh-pages-redirect.html docs/_build/html/index.html
 
       - name: Publish Docs to gh-pages
         # We pin to the SHA, not the tag, for security reasons.

diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -47,11 +47,9 @@ jobs:
 
       - name: Build Docs
         if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags')
-        # Use the args we normally pass to sphinx-build, but run sphinx-multiversion
         run: |
-          sphinx-multiversion docs docs/_build/html
+          sphinx-build docs docs/_build/html
           touch docs/_build/html/.nojekyll
-          cp docs/_assets/gh-pages-redirect.html docs/_build/html/index.html
 
       - name: Publish Docs to gh-pages
         # Only once from main or a tag

diff --git a/docs/Makefile b/docs/Makefile
@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    = # "-W" treats warnings as errors
-SPHINXBUILD   ?= sphinx-multiversion
+SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      ?= _build
 

diff --git a/docs/_assets/gh-pages-redirect.html b/docs/_assets/gh-pages-redirect.html
diff --git a/docs/conf.py b/docs/conf.py
@@ -46,7 +46,6 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.mathjax",
     "nbsphinx",
-    "sphinx_multiversion",
 ]
 
 nbsphinx_execute = "never"
@@ -130,22 +129,6 @@
 #
 # html_sidebars = {}
 
-# Whitelist pattern for remotes (set to None to use local branches only)
-smv_remote_whitelist = r"^origin$"
-
-# Whitelist pattern for branches (set to None to ignore all branches)
-smv_branch_whitelist = r"^main$"
-
-# Tags are released
-smv_released_pattern = r"^refs/tags/.*$"
-
-# Tags like 0.0.1, 0.5.1 are kept
-# smv_tag_whitelist = r'^\d+\.\d+\.\d+S'
-
-# sphinx-multiversion options
-smv_rebuild_tags = False
-smv_tag_whitelist = r"^\d+\.\d+.\d+$"
-
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,5 +1,4 @@
 black==22.3.0
-git+https://github.com/dls-controls/sphinx-multiversion.git@only-arg
 ipython>=5.8.0
 nbsphinx>=0.4.2
 pydata-sphinx-theme>=0.6.3