Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add Hypothesis and utterances overlay #159

Merged
merged 3 commits into from
Feb 3, 2022
Merged

docs: add Hypothesis and utterances overlay #159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a9e0c96
docs: add Hypothesis and utterances overlay
redeboer Feb 3, 2022
d9222c9
ci: ignore cspell words
redeboer Feb 3, 2022
3e0092d
fix: ignore suchung domain
redeboer Feb 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 12 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
"sphinx.ext.napoleon",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx_comments",
"sphinx_copybutton",
"sphinx_math_dollar",
"sphinx_panels",
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion docs/formalisms/helicity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions docs/formalisms/tensor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

### Covariant Tensor formalisms

<!-- cspell:ignore anisovich Momentoperator Twomeson -->

{cite}`anisovichMomentoperatorExpansionTwomeson2002`

## Non-covariant tensor formalisms
Expand Down
2 changes: 1 addition & 1 deletion docs/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- cspell:ignore aitchison badalyan tanabashi -->
<!-- cspell:ignore aitchison badalyan particledatagroup tanabashi -->

# Glossary

Expand Down
1 change: 1 addition & 0 deletions setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down