From 1560cf7f054e086d165b4c48ee42b0b6825b5266 Mon Sep 17 00:00:00 2001 From: Nicholas Felt Date: Mon, 30 Oct 2023 08:52:55 -0700 Subject: [PATCH 1/5] fix: Run the docs environment in tox without parallelization, since it seems that tippy has a bug when run in parallelization in sphinx. --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 372b5ae9..e030e347 100644 --- 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} From 7b3bcc40761f0947836e98e8782cbe1ea9d5336a Mon Sep 17 00:00:00 2001 From: Nicholas Felt Date: Mon, 30 Oct 2023 09:18:44 -0700 Subject: [PATCH 2/5] docs: Switch to using the free macos runners to build the documentation. --- .github/workflows/test-docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml index 2528762b..ded5f065 100644 --- a/.github/workflows/test-docs.yml +++ b/.github/workflows/test-docs.yml @@ -13,7 +13,7 @@ concurrency: jobs: # Test building the docs (html, linkcheck, doctest, coverage) test-docs: - runs-on: ubuntu-latest-4-cores + runs-on: macos-latest strategy: fail-fast: false matrix: @@ -24,7 +24,7 @@ jobs: with: node-version: 18 # The node version needs to stay in sync with .readthedocs.yml - run: npm install -g @mermaid-js/mermaid-cli - - run: sudo apt install --no-install-recommends --assume-yes graphviz + - run: brew install graphviz - name: Set up Python uses: actions/setup-python@v4 with: From b5d4a50fff54bdf2a5ad84b4062967b55deb0057 Mon Sep 17 00:00:00 2001 From: Nicholas Felt Date: Mon, 30 Oct 2023 11:04:23 -0700 Subject: [PATCH 3/5] docs: Remove parallel build option from makefiles. --- docs/Makefile | 2 +- docs/make.bat | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index d0fe869f..28a822ac 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,7 +1,7 @@ # Minimal makefile for Sphinx documentation # You can set these variables from the command line. -SPHINXOPTS = -W --keep-going -j 2 +SPHINXOPTS = -W --keep-going SPHINXBUILD = python -msphinx SPHINXPROJ = tm_devices SOURCEDIR = . diff --git a/docs/make.bat b/docs/make.bat index db3c3191..6f799fbb 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -15,7 +15,7 @@ if "%BUILDDIR%" == "" ( ) set SPHINXPROJ=tm_devices if "%SPHINXOPTS%" == "" ( - set SPHINXOPTS=-W --keep-going -j 2 + set SPHINXOPTS=-W --keep-going ) if "%1" == "" goto help From 55841a3f63319ffc552e0c9db9a956a0605c9493 Mon Sep 17 00:00:00 2001 From: Nicholas Felt Date: Mon, 30 Oct 2023 14:24:51 -0700 Subject: [PATCH 4/5] ci: Revert the change to use macos to perform doc testing. It slowed the build down significantly, more than was acceptable. --- .github/workflows/test-docs.yml | 4 ++-- CHANGELOG.md | 4 ++++ docs/Makefile | 2 +- docs/make.bat | 2 +- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml index ded5f065..2528762b 100644 --- a/.github/workflows/test-docs.yml +++ b/.github/workflows/test-docs.yml @@ -13,7 +13,7 @@ concurrency: jobs: # Test building the docs (html, linkcheck, doctest, coverage) test-docs: - runs-on: macos-latest + runs-on: ubuntu-latest-4-cores strategy: fail-fast: false matrix: @@ -24,7 +24,7 @@ jobs: with: node-version: 18 # The node version needs to stay in sync with .readthedocs.yml - run: npm install -g @mermaid-js/mermaid-cli - - run: brew install graphviz + - run: sudo apt install --no-install-recommends --assume-yes graphviz - name: Set up Python uses: actions/setup-python@v4 with: diff --git a/CHANGELOG.md b/CHANGELOG.md index da22abd0..e885bb92 100644 --- 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/docs/Makefile b/docs/Makefile index 28a822ac..d0fe869f 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,7 +1,7 @@ # Minimal makefile for Sphinx documentation # You can set these variables from the command line. -SPHINXOPTS = -W --keep-going +SPHINXOPTS = -W --keep-going -j 2 SPHINXBUILD = python -msphinx SPHINXPROJ = tm_devices SOURCEDIR = . diff --git a/docs/make.bat b/docs/make.bat index 6f799fbb..db3c3191 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -15,7 +15,7 @@ if "%BUILDDIR%" == "" ( ) set SPHINXPROJ=tm_devices if "%SPHINXOPTS%" == "" ( - set SPHINXOPTS=-W --keep-going + set SPHINXOPTS=-W --keep-going -j 2 ) if "%1" == "" goto help From 6d5a34c925fe28870bcd49cf3340369b4c8b72b3 Mon Sep 17 00:00:00 2001 From: Nicholas Felt Date: Mon, 30 Oct 2023 15:17:07 -0700 Subject: [PATCH 5/5] ci: Set up tags to be signed as well. --- .github/workflows/package-release.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/package-release.yml b/.github/workflows/package-release.yml index 9220078d..421ad8ec 100644 --- 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/python-semantic-release@v8.2.0 # 8.3.0 has a bug in the version output variable id: release