Remove multiversion docs (#67)

Remove multiversion docs

.github/workflows/ci.yml

@@ -15,11 +15,11 @@ jobs:
         python-version: [ '3.9', '3.10', '3.11' ]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
@@ -32,11 +32,11 @@ jobs:
   test_docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.9'
       - name: Install dependencies

.github/workflows/publish.yml

@@ -16,11 +16,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Fetch all history for all tags and branches
         run: git fetch --prune --unshallow
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.9'
       - name: Install dependencies
@@ -40,11 +40,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.9'
       - name: Install dependencies
@@ -66,11 +66,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.9'
       - name: Install dependencies

.github/workflows/tag_and_release.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Check version in changelog
@@ -27,7 +27,7 @@ jobs:
     if: ${{ github.ref == 'refs/heads/main' }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Create new tag and release

.gitignore

@@ -16,6 +16,3 @@ test_report.xml
 /dist/
 /sdist/
 /docs/api/
-
-# Autogenerated redirection page
-/docs/_static/index.html

CHANGELOG.rst

@@ -2,6 +2,11 @@
 Changelog
 =========
 
+Version 5.9
+===========
+
+* Remove multiversion documentation. `#67 <https://github.com/iqm-finland/cortex-cli/pull/67>`_
+
 Version 5.8
 ===========
 

docs/conf.py

@@ -22,7 +22,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Cortex CLI'
-copyright = '2019-2023, IQM Finland Oy'
+copyright = '2019-2024, IQM Finland Oy'
 
 # The short X.Y version.
 version = ''
@@ -39,7 +39,7 @@
 # -- General configuration ---------------------------------------------------
 
 # require a recent version of Sphinx
-needs_sphinx = '6.2'
+needs_sphinx = '7.2'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -50,7 +50,6 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.todo',
     'sphinx.ext.intersphinx',
-    "sphinx_multiversion",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -90,8 +89,6 @@
 # documentation.
 html_theme_options = {}
 
-html_sidebars = {'**': ['navbar-logo.html', 'search-field.html', 'sbt-sidebar-nav.html', 'versioning.html']}
-
 # A shorter title for the navigation bar.  Default is the same as html_title.
 # html_short_title = None
 
@@ -138,13 +135,3 @@
     'sphinx': ('https://www.sphinx-doc.org/en/master', None),
     'python': ('https://docs.python.org/' + python_version, None),
 }
-
-# -- Options for sphinx_multiversion --------------------------------------------------
-# Only include certain tags (i.e. all tags except for ones listed below)
-# (technically a whitelist, but we treat it as blacklist by using negative lookahead regex `?!`)
-smv_tag_whitelist = r'^(?!(0\.[0-9]*)).*$'  # ignore all the versions before 4.0
-
-smv_branch_whitelist = "None"  # Do not include local branches in versions list
-smv_remote_whitelist = "None"  # Do not include remote branches in versions list
-smv_released_pattern = r'^refs/tags/.*$'  # Tags recognized as releases
-smv_outputdir_format = 'versions/{ref.name}'  # Store versioned docs in a subdirectory

docs/index.rst

@@ -15,6 +15,10 @@ Contents
    Readme <readme>
    License <license>
    Authors <authors>
+
+.. toctree::
+   :maxdepth: 1
+
    Changelog <changelog>
 
 Indices

pyproject.toml

@@ -50,9 +50,8 @@ testing = [
     "types-requests == 2.28.9"
 ]
 docs = [
-    "sphinx == 6.2.1",
-    "sphinx-book-theme == 1.0.1",
-    "sphinx-multiversion-contrib == 0.3.2"
+    "sphinx == 7.2.6",
+    "sphinx-book-theme == 1.1.2",
 ]
 cicd = [
     "twine == 4.0.2"

tox.ini

@@ -42,17 +42,15 @@ commands =
 
 [testenv:docs]
 description =
-    Invoke sphinx-multiversion to build the docs.
+    Invoke sphinx to build the docs.
 setenv =
     DOCSDIR = {toxinidir}/docs
     BUILDDIR = {toxinidir}/build/sphinx
     BUILD = html
 extras =
     docs
-allowlist_externals =
-    sphinx-multiversion
 commands =
-    sphinx-multiversion "{env:DOCSDIR}" "{env:BUILDDIR}/{env:BUILD}" -W --dev-name dev
+    sphinx-build -b {env:BUILD} "{env:DOCSDIR}" "{env:BUILDDIR}/{env:BUILD}" -W
 
 [testenv:clean]
 description =