🏗️ Update repository and project setup (#52)

* build: 🏗️ update pyproject.toml with new dependency-groups and update noxfile accordingly

* build: 🔒 update uv.lock

* ci: 👷 update pre-commit config

* chore: 🔥 remove test.txt

* chore: ♻️ add license headers

* chore: ♻️ rename LICENSE.txt to LICENSE.md

* chore: 👷 update pyproject.toml

* fix: 🐛 fix cmake settings in pyproject.toml that are no longer allowed

* fix: 🐛 add guards for imports on optional dependencies

* chore: 📌 pin versions for docs dependencies

* refactor: ♻️ add namespace to all cpp files

* refactor: 🚨 resolve linter issue

* build: ➕ add pybtex dependency for docs

* fix: 🐛 fix doxygen path in noxfile

* chore: ♻️ update .readthedocs.yaml file to use uv

* chore: ➖ remove pybtex dependency for docs again

* build: ➕ add hoverxref dependency for docs

* docs: 📝 update docs build

Author: DRovara

.cmake-format.yaml

@@ -2,3 +2,6 @@ format:
   line_width: 100
   keyword_case: "upper"
   autosort: true
+
+markup:
+  first_comment_is_literal: true

.license-tools-config.json

@@ -0,0 +1,38 @@
+{
+  "author": {
+    "name": "Chair for Design Automation, TUM\nCopyright (c) 2025 Munich Quantum Software Company GmbH",
+    "years": [2024, 2025]
+  },
+  "force_author": true,
+  "license": "MIT",
+  "title": false,
+  "include": ["**/*"],
+  "style_override_for_suffix": {
+    ".pyi": "DOCSTRING_STYLE",
+    ".yaml": "POUND_STYLE",
+    ".toml": "POUND_STYLE",
+    ".in": "POUND_STYLE"
+  },
+  "exclude": [
+    "^\\.[^/]+",
+    "/\\.[^/]+",
+    ".*\\.qasm",
+    ".*\\.md",
+    ".*\\.bib",
+    ".*\\.cff",
+    ".*\\.css",
+    ".*\\.json",
+    ".*\\.html",
+    ".*\\.tfc",
+    ".*\\.qc",
+    ".*\\.real",
+    ".*\\.tex",
+    ".*\\.out",
+    ".*\\.rst",
+    ".*\\.txt",
+    "uv\\.lock",
+    "py\\.typed",
+    ".*build.*",
+    "Doxyfile"
+  ]
+}

.pre-commit-config.yaml

@@ -60,22 +60,24 @@ repos:
     repo: https://github.com/adamchainz/blacken-docs
     rev: 1.18.0
   - hooks:
-      - additional_dependencies:
-          - pyyaml
-        files: (\.cmake|CMakeLists.txt)(.in)?$
-        id: cmake-format
-        types:
-          - file
-    repo: https://github.com/cheshirekow/cmake-format-precommit
-    rev: v0.6.13
+      - id: license-tools
+    repo: https://github.com/emzeat/mz-lictools
+    rev: v2.7.0
   - hooks:
       - id: clang-format
         types_or:
           - c++
           - c
           - cuda
     repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: v18.1.8
+    rev: v20.1.3
+  - hooks:
+      - id: cmake-format
+        additional_dependencies: [pyyaml]
+        types: [file]
+        files: (\.cmake|CMakeLists.txt)(.in)?$
+    repo: https://github.com/cheshirekow/cmake-format-precommit
+    rev: v0.6.13
   - hooks:
       - id: prettier
         types_or:

.readthedocs.yaml

@@ -1,30 +1,42 @@
 version: 2
 
-submodules:
-  include: all
-  recursive: true
+formats:
+  - pdf
+  - htmlzip
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.11"
+    python: "3.12"
+  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/workflows/support*;
+        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
-
-sphinx:
-  configuration: docs/conf.py
-
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs
+      # 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

CMakeLists.txt

@@ -1,3 +1,10 @@
+# Copyright (c) 2024 - 2025 Chair for Design Automation, TUM Copyright (c) 2025 Munich Quantum
+# Software Company GmbH All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 cmake_minimum_required(VERSION 3.26)
 cmake_policy(SET CMP0069 NEW)
 set(CMAKE_POLICY_DEFAULT_CMP0069 NEW)

LICENSE.txt LICENSE.mdLICENSE.txt renamed to LICENSE.md

@@ -1,3 +1,10 @@
+# Copyright (c) 2024 - 2025 Chair for Design Automation, TUM Copyright (c) 2025 Munich Quantum
+# Software Company GmbH All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 add_executable(mqt_debugger_app testDDSimDebugger.cpp)
 
 # set include directories

app/CMakeLists.txt

@@ -1,3 +1,13 @@
+/*
+ * Copyright (c) 2024 - 2025 Chair for Design Automation, TUM
+ * Copyright (c) 2025 Munich Quantum Software Company GmbH
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License
+ */
+
 /**
  * @file testDDSimDebugger.cpp
  * @brief A test application that runs the CLI frontend using the DD backend.
@@ -11,6 +21,8 @@
 #include <sstream>
 #include <string>
 
+using namespace mqt::debugger;
+
 int main() {
   std::ifstream file("program.qasm");
   if (!file.is_open()) {

app/testDDSimDebugger.cpp

@@ -1,3 +1,11 @@
+# Copyright (c) 2024 - 2025 Chair for Design Automation, TUM
+# Copyright (c) 2025 Munich Quantum Software Company GmbH
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 include(FetchContent)
 set(FETCH_PACKAGES "")
 

cmake/ExternalDependencies.cmake

@@ -1,3 +1,11 @@
+# Copyright (c) 2024 - 2025 Chair for Design Automation, TUM
+# Copyright (c) 2025 Munich Quantum Software Company GmbH
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 # Source: https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#can-i-do-make-uninstall-with-cmake
 
 if(NOT EXISTS "@CMAKE_BINARY_DIR@/install_manifest.txt")