docs: add Hypothesis and utterances overlay

docs/conf.py

@@ -16,7 +16,7 @@
 # -- Project information -----------------------------------------------------
 project = "BESIII Offline Software System"
 package = "bossdoc"
-repo_name = "bossdoc"
+REPO_NAME = "bossdoc"
 copyright = "2020, BESIII"
 
 if os.path.exists(f"../src/{package}/version.py"):
@@ -65,6 +65,7 @@ def fetch_logo(url: str, output_path: str) -> None:
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
     "sphinx.ext.todo",
+    "sphinx_comments",
     "sphinx_copybutton",
     "sphinx_math_dollar",
     "sphinx_panels",
@@ -104,7 +105,7 @@ def fetch_logo(url: str, output_path: str) -> None:
 html_sourcelink_suffix = ""
 html_theme = "sphinx_book_theme"
 html_theme_options = {
-    "repository_url": f"https://github.com/redeboer/{repo_name}",
+    "repository_url": f"https://github.com/redeboer/{REPO_NAME}",
     "repository_branch": "main",
     "path_to_docs": "docs",
     "use_download_button": True,
@@ -190,6 +191,16 @@ def fetch_logo(url: str, output_path: str) -> None:
 ]
 myst_update_mathjax = False
 
+# Settings for sphinx_comments
+comments_config = {
+    "hypothesis": True,
+    "utterances": {
+        "repo": f"ComPWA/{REPO_NAME}",
+        "issue-term": "pathname",
+        "label": "📝 Docs",
+    },
+}
+
 # Settings for Thebe cell output
 thebe_config = {
     "repository_url": html_theme_options["repository_url"],

setup.cfg

@@ -44,6 +44,7 @@ install_requires =
     myst-nb >=0.11  # myst_enable_extensions
     Sphinx >=3
     sphinx-book-theme
+    sphinx-comments
     sphinx-copybutton
     sphinx-math-dollar
     sphinx-panels