docs: add Hypothesis and utterances overlay (#159)

ComPWA · Feb 3, 2022 · 795733e · 795733e
1 parent 08c1f43
commit 795733e
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 3 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -59,7 +59,7 @@ repos:
       - id: black
 
   - repo: https://github.com/asottile/blacken-docs
-    rev: v1.12.0
+    rev: v1.12.1
     hooks:
       - id: blacken-docs
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -86,6 +86,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
+    "sphinx_comments",
     "sphinx_copybutton",
     "sphinx_math_dollar",
     "sphinx_panels",
@@ -173,6 +174,7 @@
 linkcheck_ignore = [
     "http://127.0.0.1:8000",
     "https://doi.org/10.1093/ptep/ptaa104",
+    "https://suchung.web.cern.ch",
 ]
 
 # Settings for myst_nb
@@ -212,6 +214,16 @@
 }
 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"],

diff --git a/docs/formalisms/helicity.md b/docs/formalisms/helicity.md
@@ -79,7 +79,7 @@ an example here. -->
 
 Recommended literature:
 
-<!-- cspell:ignore aaij marangotto -->
+<!-- cspell:ignore aaij Dalitzplot jpaccollaboration marangotto Threebody -->
 <!-- markdownlint-disable -->
 
 - General introductions to helicity angles: <br>

diff --git a/docs/formalisms/tensor.md b/docs/formalisms/tensor.md
@@ -6,6 +6,8 @@
 
 ### Covariant Tensor formalisms
 
+<!-- cspell:ignore anisovich Momentoperator Twomeson -->
+
 {cite}`anisovichMomentoperatorExpansionTwomeson2002`
 
 ## Non-covariant tensor formalisms

diff --git a/docs/glossary.md b/docs/glossary.md
@@ -1,4 +1,4 @@
-<!-- cspell:ignore aitchison badalyan tanabashi -->
+<!-- cspell:ignore aitchison badalyan particledatagroup tanabashi -->
 
 # Glossary
 

diff --git a/setup.cfg b/setup.cfg
@@ -64,6 +64,7 @@ doc =
     myst-nb >=0.11  # myst_enable_extensions
     Sphinx >=3
     sphinx-book-theme
+    sphinx-comments
     sphinx-copybutton
     sphinx-math-dollar
     sphinx-panels