🔧 Maintenance round (#709)

## Description

This PR makes several maintenance updates:

- Fix `required-checks-pass` job
- Use `client-id` instead of `app-id`
- Update to new MQSC branding
- Improve support for `CLAUDE.md`
- Configure Read the Docs to use Python 3.14 for colorful docs
- Configure Read the Docs to natively use `uv`

## Checklist

- [x] The pull request only contains commits that are focused and
relevant to this change.
- [x] ~~I have added appropriate tests that cover the new/changed
functionality.~~
- [x] ~~I have updated the documentation to reflect these changes.~~
- [x] ~~I have added entries to the changelog for any noteworthy
additions, changes, fixes, or removals.~~
- [x] ~~I have added migration instructions to the upgrade guide (if
needed).~~
- [x] The changes follow the project's style guidelines and introduce no
new warnings.
- [x] The changes are fully tested and pass the CI checks.
- [x] I have reviewed my own code changes.

Author: denialhaag

.github/workflows/ci.yml

@@ -76,11 +76,11 @@ jobs:
         with:
           allowed-skips: >-
             ${{
-              fromJSON(needs.change-detection.outputs.run-python-tests)
-              && '' || 'python-tests,python-coverage,python-linter,'
+              !fromJSON(needs.change-detection.outputs.run-python-tests)
+              && 'python-tests,python-coverage,python-linter,' || ''
             }}
             ${{
-              fromJSON(needs.change-detection.outputs.run-cd)
-              && '' || 'build-sdist,build-wheel,'
+              !fromJSON(needs.change-detection.outputs.run-cd)
+              && 'build-sdist,build-wheel' || ''
             }}
           jobs: ${{ toJSON(needs) }}

.github/workflows/templating.yml

@@ -19,7 +19,7 @@ jobs:
       - id: create-token
         uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
         with:
-          app-id: ${{ secrets.APP_ID }}
+          client-id: ${{ secrets.APP_ID }}
           private-key: ${{ secrets.APP_PRIVATE_KEY }}
       - uses: munich-quantum-toolkit/templates@7fe3464fde16330f8d452127a16e29019d7fc81c # v1.3.1
         with:

.gitignore

@@ -1,8 +1,3 @@
-model_*.zip
-*.qasm
-*.DS_Store
-*-checkpoint.ipynb
-
 /build*
 /cmake-build-*
 .idea/*
@@ -52,4 +47,21 @@ venv.bak/
 .ruff_cache/
 .mypy_cache/
 
+CLAUDE.md
+.claude/
+
+.DS_Store
+.DS_Store?
+.Spotlight-V100
+.Trashes
+._*
+Thumbs.db
+editor.swp
+editor~
+ehthumbs.db
+
+model_*.zip
+*.qasm
+*-checkpoint.ipynb
+
 src/**/_version.py

.readthedocs.yaml

@@ -3,33 +3,17 @@ version: 2
 formats:
   - htmlzip
 
+sphinx:
+  configuration: docs/conf.py
+
 build:
   os: ubuntu-24.04
   tools:
-    python: "3.12"
-  jobs:
-    post_checkout:
-      # Skip docs build if the commit message contains "skip ci"
-      - (git --no-pager log --pretty="tformat:%s -- %b" -1 | grep -viq "skip ci") || exit 183
-      # Skip docs build if there are no changes related to docs
-      - |
-        if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ src/mqt/ .github/SUPPORT.md .readthedocs.yaml;
-        then
-          exit 183;
-        fi
-      # Unshallow the git clone and fetch tags to get proper version information
-      - git fetch --unshallow --tags
-    pre_build:
-      # Set up uv
-      - asdf plugin add uv
-      - asdf install uv latest
-      - asdf global uv latest
-    build:
-      html:
-        - uv run --frozen --no-dev --group docs -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
-      htmlzip:
-        - uv run --frozen --no-dev --group docs -m sphinx -T -b dirhtml -d docs/_build/doctrees -D language=en docs docs/_build/dirhtml
-        - mkdir -p $READTHEDOCS_OUTPUT/htmlzip
-        - zip -r $READTHEDOCS_OUTPUT/htmlzip/html.zip docs/_build/dirhtml/*
-sphinx:
-  configuration: docs/conf.py
+    python: "3.14"
+
+python:
+  install:
+    - method: uv
+      command: sync
+      groups:
+        - docs

README.md

@@ -49,7 +49,7 @@ If you have any questions, feel free to create a [discussion](https://github.com
 
 ## Contributors and Supporters
 
-The _[Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io)_ is developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) and supported by the [Munich Quantum Software Company (MQSC)](https://munichquantum.software).
+The _[Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io)_ is developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) and supported by [MQSC](https://mq.sc).
 Among others, it is part of the [Munich Quantum Software Stack (MQSS)](https://www.munich-quantum-valley.de/research/research-areas/mqss) ecosystem, which is being developed as part of the [Munich Quantum Valley (MQV)](https://www.munich-quantum-valley.de) initiative.
 
 <p align="center">

docs/conf.py

@@ -34,9 +34,10 @@
 release = version.split("+")[0]
 
 project = "MQT Predictor"
-author = "Chair for Design Automation, TUM & Munich Quantum Software Company"
+author = "Chair for Design Automation, TUM & Munich Quantum Software Company GmbH"
 language = "en"
-project_copyright = "2023 - 2026 Chair for Design Automation, TUM & 2025 - 2026 Munich Quantum Software Company"
+project_copyright = "2023 - 2026 Chair for Design Automation, TUM & 2025 - 2026 Munich Quantum Software Company GmbH"
+
 # -- General configuration ---------------------------------------------------
 
 master_doc = "index"
@@ -45,19 +46,19 @@
 html_css_files = ["custom.css"]
 
 extensions = [
-    "myst_nb",
     "autoapi.extension",
-    "sphinx.ext.napoleon",
+    "myst_nb",
+    "sphinx_copybutton",
+    "sphinx_design",
     "sphinx.ext.autodoc",
+    "sphinx.ext.autosectionlabel",
     "sphinx.ext.autosummary",
-    "sphinx.ext.mathjax",
+    "sphinx.ext.githubpages",
     "sphinx.ext.intersphinx",
-    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
-    "sphinx.ext.githubpages",
     "sphinxcontrib.bibtex",
-    "sphinx_copybutton",
-    "sphinx_design",
     "sphinxext.opengraph",
 ]
 

docs/index.md

@@ -59,7 +59,7 @@ support
 ```{only} html
 ## Contributors and Supporters
 
-The _[Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io)_ is developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) and supported by the [Munich Quantum Software Company (MQSC)](https://munichquantum.software).
+The _[Munich Quantum Toolkit (MQT)](https://mqt.readthedocs.io)_ is developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) and supported by [MQSC](https://mq.sc).
 Among others, it is part of the [Munich Quantum Software Stack (MQSS)](https://www.munich-quantum-valley.de/research/research-areas/mqss) ecosystem, which is being developed as part of the [Munich Quantum Valley (MQV)](https://www.munich-quantum-valley.de) initiative.
 
 <div style="margin-top: 0.5em">

src/mqt/predictor/ml/predictor.py

@@ -17,7 +17,6 @@
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
-import matplotlib.pyplot as plt
 import numpy as np
 from joblib import Parallel, delayed, load
 from joblib import dump as joblib_dump
@@ -51,7 +50,6 @@
 
     from mqt.predictor.reward import figure_of_merit
 
-plt.rcParams["font.family"] = "Times New Roman"
 
 logger = logging.getLogger("mqt-predictor")