🔧 Set up rumdl

.github/SUPPORT.md

@@ -3,8 +3,8 @@
 
 # Support
 
-If you are stuck with a problem using MQT DDSIM or have questions, please get
-in touch at our [Issues] or [Discussions]. We'd love to help.
+If you are stuck with a problem using MQT DDSIM or have questions, please get in
+touch at our [Issues] or [Discussions]. We'd love to help.
 
 You can save time by following this procedure when reporting a problem:
 

.pre-commit-config.yaml

@@ -105,9 +105,19 @@ repos:
     rev: v3.9.1
     hooks:
       - id: prettier
-        types_or: [yaml, markdown, html, css, scss, javascript, json, json5]
+        types_or: [yaml, html, css, scss, javascript, json, json5]
         priority: 5
 
+    ## Format Markdown files with rumdl
+  - repo: https://github.com/rvben/rumdl-pre-commit
+    rev: v0.2.28
+    hooks:
+      - id: rumdl
+        args: [--fix]
+        priority: 5
+      - id: rumdl-fmt
+        priority: 6
+
   ## Format CMake files with cmake-format
   - repo: https://github.com/cheshirekow/cmake-format-precommit
     rev: v0.6.13

.rumdl.toml

@@ -0,0 +1,20 @@
+[per-file-ignores]
+# The PR template is not a Markdown document in that sense
+"**/pull_request_template.md" = ["MD013", "MD041"]
+# The docs files may include HTML and do not need to start with a top-level heading
+"docs/**" = ["MD033", "MD041"]
+# The README may include HTML and does not need to start with a top-level heading
+"README.md" = ["MD033", "MD041"]
+
+[per-file-flavor]
+"docs/**" = "myst"
+
+[MD013]
+line-length = 80
+code-blocks = false
+headings = false
+reflow = true
+reflow-mode = "normalize"
+
+[MD060]
+enabled = true

CHANGELOG.md

@@ -5,19 +5,27 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on a mixture of [Keep a Changelog] and [Common Changelog].
-This project adheres to [Semantic Versioning], with the exception that minor releases may include breaking changes.
+This project adheres to [Semantic Versioning], with the exception that minor
+releases may include breaking changes.
 
 ## [Unreleased]
 
 ### Added
 
-- 🚸 Add [CMake presets] to provide a standardized and reproducible way to configure builds ([#871]) ([**@denialhaag**])
+- 🚸 Add [CMake presets] to provide a standardized and reproducible way to
+  configure builds ([#871]) ([**@denialhaag**])
 
 ### Changed
 
 - ⬆️ Update `mqt-core` to version 3.7.0 ([#911]) ([**@denialhaag**])
 - ⬆️ Update `nanobind` to version 2.13.0 ([#911]) ([**@denialhaag**])
-- ⬆️ Update [munich-quantum-toolkit/workflows] to version `v2.0.1` ([#871]) ([**@denialhaag**])
+- ⬆️ Update [munich-quantum-toolkit/workflows] to version `v2.0.1` ([#871])
+  ([**@denialhaag**])
+
+### Removed
+
+- 📝 Remove support for generating LaTeX documentation ([#912])
+  ([**@denialhaag**])
 
 ## [2.3.0] - 2026-05-13
 
@@ -37,12 +45,17 @@ _If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md#220)._
 - ⬆️ Update `mqt-core` to version 3.4.1 ([#779]) ([**@denialhaag**])
 - ⬆️ Update `nanobind` to version 2.11.0 ([#779]) ([**@denialhaag**])
 - 🔧 Replace `mypy` with `ty` ([#770]) ([**@denialhaag**])
-- ♻️ Migrate Python bindings from `pybind11` to `nanobind` ([#766], [#773]) ([**@denialhaag**])
+- ♻️ Migrate Python bindings from `pybind11` to `nanobind` ([#766], [#773])
+  ([**@denialhaag**])
 - 📦️ Provide Stable ABI wheels for Python 3.12+ ([#766]) ([**@denialhaag**])
-- 👷 Stop testing on `ubuntu-22.04` and `ubuntu-22.04-arm` runners ([#740]) ([**@denialhaag**])
-- 👷 Stop testing with `clang-19` and start testing with `clang-21` ([#740]) ([**@denialhaag**])
-- 👷 Fix macOS tests with Homebrew Clang via new `munich-quantum-toolkit/workflows` version ([#740]) ([**@denialhaag**])
-- 👷 Re-enable macOS tests with GCC by disabling module scanning ([#740]) ([**@denialhaag**])
+- 👷 Stop testing on `ubuntu-22.04` and `ubuntu-22.04-arm` runners ([#740])
+  ([**@denialhaag**])
+- 👷 Stop testing with `clang-19` and start testing with `clang-21` ([#740])
+  ([**@denialhaag**])
+- 👷 Fix macOS tests with Homebrew Clang via new
+  `munich-quantum-toolkit/workflows` version ([#740]) ([**@denialhaag**])
+- 👷 Re-enable macOS tests with GCC by disabling module scanning ([#740])
+  ([**@denialhaag**])
 
 ### Removed
 
@@ -59,7 +72,8 @@ _If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md#210)._
 
 ### Changed
 
-- ⬆️ Bump minimum required `mqt-core` version to `3.3.1` ([#681]) ([**@denialhaag**])
+- ⬆️ Bump minimum required `mqt-core` version to `3.3.1` ([#681])
+  ([**@denialhaag**])
 
 ### Removed
 
@@ -77,29 +91,39 @@ _If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md#200)._
 ### Changed
 
 - ♻️ Streamline names of Python modules and classes ([#614]) ([**@denialhaag**])
-- ⬆️ Bump minimum required `mqt-core` version to `3.2.1` ([#610]) ([**@denialhaag**])
+- ⬆️ Bump minimum required `mqt-core` version to `3.2.1` ([#610])
+  ([**@denialhaag**])
 - ⬆️ Require C++20 ([#610]) ([**@denialhaag**])
-- ✨ Expose enums to Python via `pybind11`'s new (`enum.Enum`-compatible) `py::native_enum` ([#607]) ([**@denialhaag**])
-- ⬆️ Bump minimum required `mqt-core` version to `3.1.0` ([#591]) ([**@denialhaag**])
-- ⬆️ Bump minimum required `pybind11` version to `3.0.0` ([#591]) ([**@denialhaag**])
-- ♻️ Move the C++ code for the Python bindings to the top-level `bindings` directory ([#567]) ([**@denialhaag**])
-- ♻️ Move all Python code (no tests) to the top-level `python` directory ([#567]) ([**@denialhaag**])
+- ✨ Expose enums to Python via `pybind11`'s new (`enum.Enum`-compatible)
+  `py::native_enum` ([#607]) ([**@denialhaag**])
+- ⬆️ Bump minimum required `mqt-core` version to `3.1.0` ([#591])
+  ([**@denialhaag**])
+- ⬆️ Bump minimum required `pybind11` version to `3.0.0` ([#591])
+  ([**@denialhaag**])
+- ♻️ Move the C++ code for the Python bindings to the top-level `bindings`
+  directory ([#567]) ([**@denialhaag**])
+- ♻️ Move all Python code (no tests) to the top-level `python` directory
+  ([#567]) ([**@denialhaag**])
 - ⬆️ Support Qiskit 2.0 ([#571]) ([**@denialhaag**])
 - 🚚 Move MQT DDSIM to the [munich-quantum-toolkit] GitHub organization
-- ♻️ Use the `mqt-core` Python package for handling circuits ([#336]) ([**@burgholzer**])
-- ⬆️ Bump minimum required CMake version to `3.24.0` ([#538]) ([**@burgholzer**])
+- ♻️ Use the `mqt-core` Python package for handling circuits ([#336])
+  ([**@burgholzer**])
+- ⬆️ Bump minimum required CMake version to `3.24.0` ([#538])
+  ([**@burgholzer**])
 - 📝 Rework existing project documentation ([#556]) ([**@burgholzer**])
 
 ### Removed
 
 - 🔥 Remove methods for querying maximum node count ([#591]) ([**@denialhaag**])
 - 🔥 Remove the TN flow from the path simulator ([#336]) ([**@burgholzer**])
 - 🔥 Remove some superfluous C++ executables ([#336]) ([**@burgholzer**])
-- 🔥 Remove support for `.real`, `.qc`, `.tfc`, and `GRCS` files ([#538]) ([**@burgholzer**])
+- 🔥 Remove support for `.real`, `.qc`, `.tfc`, and `GRCS` files ([#538])
+  ([**@burgholzer**])
 
 ### Fixed
 
-- 🚸 Increase binary compatibility between `mqt-ddsim` and `mqt-core` ([#606]) ([**@denialhaag**])
+- 🚸 Increase binary compatibility between `mqt-ddsim` and `mqt-core` ([#606])
+  ([**@denialhaag**])
 
 ## [1.24.0] - 2024-10-10
 
@@ -116,6 +140,7 @@ _📚 Refer to the [GitHub Release Notes] for previous changelogs._
 
 <!-- PR links -->
 
+[#912]: https://github.com/munich-quantum-toolkit/ddsim/pull/912
 [#911]: https://github.com/munich-quantum-toolkit/ddsim/pull/911
 [#871]: https://github.com/munich-quantum-toolkit/ddsim/pull/871
 [#847]: https://github.com/munich-quantum-toolkit/ddsim/pull/847
@@ -127,7 +152,6 @@ _📚 Refer to the [GitHub Release Notes] for previous changelogs._
 [#681]: https://github.com/munich-quantum-toolkit/ddsim/pull/681
 [#674]: https://github.com/munich-quantum-toolkit/ddsim/pull/674
 [#645]: https://github.com/munich-quantum-toolkit/ddsim/pull/645
-[#640]: https://github.com/munich-quantum-toolkit/ddsim/pull/640
 [#614]: https://github.com/munich-quantum-toolkit/ddsim/pull/614
 [#610]: https://github.com/munich-quantum-toolkit/ddsim/pull/610
 [#608]: https://github.com/munich-quantum-toolkit/ddsim/pull/608