📝 Add documentation for DD package

.license-tools-config.json

@@ -22,6 +22,7 @@
     ".*\\.tfc",
     ".*\\.qc",
     ".*\\.real",
+    ".*\\.tex",
     ".*\\.toml",
     ".*\\.yaml",
     "uv\\.lock",

.pre-commit-config.yaml

@@ -148,3 +148,21 @@ repos:
     rev: 2024.11.25
     hooks:
       - id: validate-pyproject
+
+  # Tidy up BibTeX files
+  - repo: https://github.com/FlamingTempura/bibtex-tidy
+    rev: v1.14.0
+    hooks:
+      - id: bibtex-tidy
+        args:
+          [
+            "--align=20",
+            "--curly",
+            "--months",
+            "--blank-lines",
+            "--sort",
+            "--strip-enclosing-braces",
+            "--sort-fields",
+            "--trailing-commas",
+            "--remove-empty-fields",
+          ]

.readthedocs.yaml

@@ -5,35 +5,38 @@ formats:
   - htmlzip
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
     python: "3.12"
-  commands:
-    # 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/ .readthedocs.yaml src/mqt/ src/python include/*/python .github/contributing* .github/support*;
-      then
-        exit 183;
-      fi
-    # Set up uv and a virtual environment
-    - asdf plugin add uv
-    - asdf install uv latest
-    - asdf global uv latest
-    # Unshallow the git clone and fetch tags to get proper version information
-    - git fetch --unshallow --tags
-    # Run the html builder
-    - uv run --frozen --no-dev --group docs -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
-    # Run the htmlzip builder and create a zip file
-    - 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/*
-    # Run the latex builder and create a pdf file
-    - uv run --frozen --no-dev --group docs -m sphinx -T -b latex -d docs/_build/doctrees -D language=en docs docs/_build/latex
-    - cd docs/_build/latex && latexmk -pdf -f -dvi- -ps- -interaction=nonstopmode -jobname=$READTHEDOCS_PROJECT
-    - mkdir -p $READTHEDOCS_OUTPUT/pdf
-    - cp docs/_build/latex/$READTHEDOCS_PROJECT.pdf $READTHEDOCS_OUTPUT/pdf/$READTHEDOCS_PROJECT.pdf
-
-sphinx:
-  configuration: docs/conf.py
+  apt_packages:
+    - graphviz
+    - inkscape
+  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/ .readthedocs.yaml src/mqt/ src/python include/*/python .github/contributing* .github/support*;
+        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/*
+      pdf:
+        - uv run --frozen --no-dev --group docs -m sphinx -T -b latex -d docs/_build/doctrees -D language=en docs docs/_build/latex
+        - cd docs/_build/latex && latexmk -pdf -f -dvi- -ps- -interaction=nonstopmode -jobname=$READTHEDOCS_PROJECT
+        - mkdir -p $READTHEDOCS_OUTPUT/pdf
+        - cp docs/_build/latex/$READTHEDOCS_PROJECT.pdf $READTHEDOCS_OUTPUT/pdf/$READTHEDOCS_PROJECT.pdf