Merge pull request #965 from pohly/sphinx-dox-versioning

Sphinx dox versioning

Author: pohly

.github/workflows/publish.yml

@@ -5,6 +5,8 @@ on:
     branches:
         - devel
         - release-0.7
+        - release-0.8
+        - release-0.9
 
 jobs:
   build:
@@ -23,16 +25,18 @@ jobs:
       run: |
         mkdir $HOME/output
         touch $HOME/output/.nojekyll
-        # This is the static index page for https://intel.github.io/pmem-csi,
-        # copied from the "devel" branch.
-        cp docs/html/index2.html $HOME/output/index.html
+        # https://intel.github.io/pmem-csi/ redirects to the latest stable release.
+        echo "<meta http-equiv=\"refresh\" content=\"0; URL='0.9/index.html'\" />" >"$HOME/output/index.html"
+        # "latest" used to be what "devel" is now, i.e. the documentation for the "devel"
+        # branch. Now it points to the latest stable release.
+        ln -s 0.9 "$HOME/output/latest"
     - name: Build latest
       run: |
         GITHUB_SHA=$(git rev-parse HEAD)
         export GITHUB_SHA
         rm -rf _work/venv
         make vhtml
-        mv _output/html $HOME/output/latest
+        mv _output/html $HOME/output/devel
     - uses: actions/checkout@v2
       with:
         ref: release-0.7

README.md

@@ -16,10 +16,10 @@ and bug fixes. Older releases are no longer supported.
 
 Documentation is part of the source code for each release and also
 available in rendered form for easier reading:
-- [latest documentation, in development](https://intel.github.io/pmem-csi/latest/)
-- [latest 0.7.x release](https://intel.github.io/pmem-csi/0.7/)
-- [latest 0.8.x release](https://intel.github.io/pmem-csi/0.8/)
 - [latest 0.9.x release](https://intel.github.io/pmem-csi/0.9/)
+- [latest 0.8.x release](https://intel.github.io/pmem-csi/0.8/)
+- [latest 0.7.x release](https://intel.github.io/pmem-csi/0.7/)
+- [latest documentation, in development](https://intel.github.io/pmem-csi/devel/)
 
 ## Supported Kubernetes versions
 

conf.py

@@ -2,6 +2,7 @@
 import json
 import os
 import sys
+import subprocess
 from os import getenv
 #support for modified code block
 from pygments.lexers.shell import BashSessionLexer
@@ -29,6 +30,15 @@ class copyAllConsole (BashSessionLexer):
 for item in conf:
     globals()[item] = (conf[item])
 
+# Dynamically determine the major version based on the branch name:
+# vx.y for release-x.y, "devel" for everything else
+branch = subprocess.check_output("git rev-parse --abbrev-ref HEAD".split(), encoding="utf-8")
+if branch.startswith("release-"):
+    version = "v" + branch[len("release-"):].strip()
+else:
+    version = "devel"
+release = version
+
 sphinx_md_useGitHubURL = True
 baseBranch = "devel"
 commitSHA = getenv('GITHUB_SHA')
@@ -42,4 +52,4 @@ class copyAllConsole (BashSessionLexer):
     githubFileURL = githubFileURL + baseBranch + "/"
     githubDirURL = githubDirURL + baseBranch + "/"
 sphinx_md_githubFileURL = githubFileURL
-sphinx_md_githubDirURL = githubDirURL
+sphinx_md_githubDirURL = githubDirURL