Read the Docs Implementation

.readthedocs.yaml

@@ -0,0 +1,30 @@
+version: 2
+
+submodules:
+  include: all
+  recursive: true
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  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/ .github/contributing* .github/workflows/support*;
+        then
+          exit 183;
+        fi
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

docs/conf.py

@@ -0,0 +1,92 @@
+"""Sphinx configuration file."""
+
+from __future__ import annotations
+
+import warnings
+from importlib import metadata
+from pathlib import Path
+
+ROOT = Path(__file__).parent.parent.resolve()
+
+
+try:
+    from mqt.bench import __version__ as version
+except ModuleNotFoundError:
+    try:
+        version = metadata.version("mqt.bench")
+    except ModuleNotFoundError:
+        msg = (
+            "Package should be installed to produce documentation! "
+            "Assuming a modern git archive was used for version discovery."
+        )
+        warnings.warn(msg, stacklevel=1)
+
+        from setuptools_scm import get_version
+
+        version = get_version(root=str(ROOT), fallback_root=ROOT)
+
+# Filter git details from version
+release = version.split("+")[0]
+
+project = "MQT Bench"
+author = "Chair for Design Automation, Technical University of Munich"
+language = "en"
+project_copyright = "2023, Chair for Design Automation, Technical University of Munich"
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.intersphinx",
+    "sphinx_design",
+    "sphinx_copybutton",
+    "sphinxext.opengraph",
+]
+
+source_suffix = [".rst", ".md"]
+
+exclude_patterns = [
+    "_build",
+    "**.ipynb_checkpoints",
+    "Thumbs.db",
+    ".DS_Store",
+    ".env",
+    ".venv",
+]
+
+pygments_style = "colorful"
+
+add_module_names = False
+
+modindex_common_prefix = ["mqt.bench."]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "qiskit": ("https://qiskit.org/documentation/", None),
+    "mqt": ("https://mqt.readthedocs.io/en/latest/", None),
+}
+intersphinx_disabled_reftypes = ["*"]
+
+myst_enable_extensions = [
+    "colon_fence",
+    "substitution",
+    "deflist",
+]
+
+myst_substitutions = {
+    "version": version,
+}
+
+copybutton_prompt_text = r"(?:\(venv\) )?(?:\[.*\] )?\$ "
+copybutton_prompt_is_regexp = True
+copybutton_line_continuation_character = "\\"
+
+# -- Options for HTML output -------------------------------------------------
+html_theme = "furo"
+html_static_path = ["_static"]
+html_theme_options = {
+    "light_logo": "mqt_dark.png",
+    "dark_logo": "mqt_light.png",
+    "source_repository": "https://github.com/cda-tum/mqt-bench/",
+    "source_branch": "main",
+    "source_directory": "docs/",
+    "navigation_with_keys": True,
+}

docs/index.md

@@ -0,0 +1,7 @@
+# MQT Bench - A MQT tool for Benchmarking Quantum Software Tools
+
+The MQT Bench library forms is part of the quantum software tools developed as part of the _{doc}`Munich Quantum Toolkit (MQT) <mqt:index>`_ by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/).
+
+```{include} ../README.md
+:start-after: <!-- SPHINX-START -->
+```

pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 requires = [
     "setuptools>=61",
-    "setuptools_scm[toml]>=7",
+    "setuptools_scm>=7",
 ]
 build-backend = "setuptools.build_meta"