Sanitize ref name for docs version

Translate punctuation and unicode in branch names to _

Author: coretl

.github/workflows/docs.yml

@@ -41,12 +41,14 @@ jobs:
       - name: Build docs
         run: tox -e docs
 
+      - name: Sanitize ref name for docs version
+        run: echo "DOCS_VERSION=${GITHUB_REF_NAME//[^A-Za-z0-9._-]/_}" >> $GITHUB_ENV
+
       - name: Move to versioned directory
-        # e.g. main or 0.1.2
-        run: mv build/html ".github/pages/${{ github.ref_name }}"
+        run: mv build/html .github/pages/$DOCS_VERSION
 
       - name: Write switcher.json
-        run: python .github/pages/make_switcher.py --add "${{ github.ref_name }}" ${{ github.repository }} .github/pages/switcher.json
+        run: python .github/pages/make_switcher.py --add $DOCS_VERSION ${{ github.repository }} .github/pages/switcher.json
 
       - name: Publish Docs to gh-pages
         if: github.event_name == 'push'

.github/workflows/docs_clean.yml

@@ -24,17 +24,20 @@ jobs:
 
       - name: removing documentation for branch ${{ github.event.ref }}
         if: ${{ github.event_name != 'workflow_dispatch' }}
-        run: echo "remove_me=${{ github.event.ref }}" >> $GITHUB_ENV
+        run: echo "REF_NAME=${{ github.event.ref }}" >> $GITHUB_ENV
 
       - name: manually removing documentation version ${{ github.event.inputs.version }}
         if: ${{ github.event_name == 'workflow_dispatch' }}
-        run: echo "remove_me=${{ github.event.inputs.version }}" >> $GITHUB_ENV
+        run: echo "REF_NAME=${{ github.event.inputs.version }}" >> $GITHUB_ENV
+
+      - name: Sanitize ref name for docs version
+        run: echo "DOCS_VERSION=${REF_NAME//[^A-Za-z0-9._-]/_}" >> $GITHUB_ENV
 
       - name: update index and push changes
         run: |
-          rm -r ${{ env.remove_me }}
-          python make_switcher.py --remove ${{ env.remove_me }} ${{ github.repository }} switcher.json
+          rm -r ${{ env.DOCS_VERSION }}
+          python make_switcher.py --remove $DOCS_VERSION ${{ github.repository }} switcher.json
           git config --global user.name 'GitHub Actions Docs Cleanup CI'
           git config --global user.email '[email protected]'
-          git commit -am"removing redundant docs version ${{ env.remove_me }}"
+          git commit -am "Removing redundant docs version $DOCS_VERSION"
           git push

setup.cfg

@@ -123,5 +123,7 @@ allowlist_externals = pre-commit
 commands = pre-commit run --all-files {posargs}
 
 [testenv:docs]
-allowlist_externals = sphinx-build sphinx-autobuild
+allowlist_externals =
+    sphinx-build
+    sphinx-autobuild
 commands = sphinx-{posargs:build -EW --keep-going} -T docs build/html