fix: Build docs without parallelization to fix pop-up issues with sph…

…inx-tippy (tektronix#80) * fix: Run the docs environment in tox without parallelization, since it seems that tippy has a bug when run in parallelization in sphinx. * ci: Set up tags to be signed as well. Signed-off-by: qthompso <[email protected]>
qthompso · Feb 15, 2024 · 8e504f1 · 8e504f1
1 parent f630095
commit 8e504f1
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/.github/workflows/package-release.yml b/.github/workflows/package-release.yml
@@ -41,6 +41,7 @@ jobs:
         run: |
           python scripts/check_unreleased_changelog_items.py
           git add python_semantic_release_templates
+          git config --global tag.gpgSign true
       - name: Python Semantic Release
         uses: python-semantic-release/[email protected]  # 8.3.0 has a bug in the version output variable
         id: release

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,10 @@ ______________________________________________________________________
 
 Things to be included in the next release go here.
 
+### Fixed
+
+- Fixed the `tippy.js` pop-ups in the documentation
+
 ______________________________________________________________________
 
 ## v0.1.23 (2023-10-30)

diff --git a/pyproject.toml b/pyproject.toml
@@ -448,7 +448,7 @@ deps =
 commands_pre =
 commands =
     python -c "import shutil; shutil.rmtree('.results_{envname}', ignore_errors=True)"
-    sphinx-build -b html -a -W --keep-going -j 3 docs .results_{envname}/html
+    sphinx-build -b html -a -W --keep-going docs .results_{envname}/html
 
 [testenv:doctests]
 basepython = {env:DOC_PYTHON_VERSION}