Set up versioning with mkdocs (#850)

.github/workflows/generate_docs.yml

@@ -11,12 +11,17 @@ jobs:
     steps:
       - name: Checkout main
         uses: actions/checkout@v2
-
-      - name: Deploy docs
-        uses: mhausenblas/mkdocs-deploy-gh-pages@master
-        # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          CONFIG_FILE: documentation/mkdocs.yml
-          EXTRA_PACKAGES: build-base
-          REQUIREMENTS: documentation/requirements.txt
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - run: |
+          cd documentation
+          pip install -r requirements.txt
+          git config user.name docs && git config user.email [email protected]
+          git fetch origin gh-pages --depth=1
+          if [ ${{ github.ref }} == 'refs/heads/master' ]
+          then
+            mike deploy latest --push
+          else
+            mike deploy dev --push
+          fi

documentation/mkdocs.yml

@@ -22,6 +22,12 @@ theme:
         name: Switch to light mode
 plugins:
   - swagger-ui-tag
+  - mike:
+      # These fields are all optional; the defaults are as below...
+      canonical_version: null
+      version_selector: true
+      css_dir: css
+      javascript_dir: js
 nav:
   - Home: index.md
   - Setup:
@@ -59,3 +65,7 @@ markdown_extensions:
 extra_javascript:
   - https://unpkg.com/[email protected]/dist/tablesort.min.js
   - javascripts/tablesort.js
+extra:
+  version:
+    default: latest
+    provider: mike

documentation/requirements.txt

@@ -1 +1,4 @@
 mkdocs-swagger-ui-tag==0.3.0
+mkdocs
+mkdocs-material
+mike