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

DOC: add Sphinx bibtex support #219

Merged
merged 4 commits into from
Oct 13, 2022
Merged

DOC: add Sphinx bibtex support #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ef38667
DX: recommend MyST extension for VSCode
redeboer Oct 13, 2022
6778238
DOC: rename homomorphism notebook
redeboer Oct 13, 2022
78aa35d
DOC: add explainer to SU(2) → SO(3) page
redeboer Oct 13, 2022
d6da822
MAINT: update pip constraints and pre-commit config
web-flow Oct 13, 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
10 changes: 7 additions & 3 deletions .constraints/py3.10.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jinja2==3.1.2
json5==0.9.10
jsonschema==4.16.0
jupyter-cache==0.5.0
jupyter-client==7.4.1
jupyter-client==7.4.2
jupyter-core==4.11.1
jupyter-server==1.21.0
jupyterlab==3.4.8
Expand All @@ -75,6 +75,7 @@ jupyterlab-server==2.15.2
jupyterlab-widgets==3.0.3
kaleido==0.2.1
kiwisolver==1.4.4
latexcodec==2.0.1
livereload==2.6.3
lxml==4.9.1
markdown-it-py==2.1.0
Expand All @@ -88,7 +89,7 @@ mpmath==1.2.1
mypy-extensions==0.4.3
myst-nb==0.17.1
myst-parser==0.18.1
nbclassic==0.4.5
nbclassic==0.4.6
nbclient==0.5.13
nbconvert==7.2.1
nbformat==5.7.0
Expand All @@ -97,7 +98,7 @@ nest-asyncio==1.5.6
nodeenv==1.7.0
notebook==6.4.12
notebook-shim==0.1.0
numpy==1.23.3
numpy==1.23.4
opt-einsum==3.3.0
packaging==21.3
pandas==1.5.0
Expand All @@ -118,6 +119,8 @@ psutil==5.9.2
ptyprocess==0.7.0
pure-eval==0.2.2
py==1.11.0
pybtex==0.24.0
pybtex-docutils==1.0.2
pycparser==2.21
pydantic==1.10.2
pydata-sphinx-theme==0.8.1
Expand Down Expand Up @@ -148,6 +151,7 @@ sphinx-copybutton==0.5.0
sphinx-design==0.3.0
sphinx-togglebutton==0.3.2
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-bibtex==2.5.0
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
Expand Down
8 changes: 6 additions & 2 deletions .constraints/py3.7.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ jinja2==3.1.2
json5==0.9.10
jsonschema==4.16.0
jupyter-cache==0.5.0
jupyter-client==7.4.1
jupyter-client==7.4.2
jupyter-core==4.11.1
jupyter-server==1.21.0
jupyterlab==3.4.8
Expand All @@ -72,6 +72,7 @@ jupyterlab-server==2.15.2
jupyterlab-widgets==3.0.3
kaleido==0.2.1
kiwisolver==1.4.4
latexcodec==2.0.1
livereload==2.6.3
lxml==4.9.1
markdown-it-py==2.1.0
Expand All @@ -85,7 +86,7 @@ mpmath==1.2.1
mypy-extensions==0.4.3
myst-nb==0.17.1
myst-parser==0.18.1
nbclassic==0.4.5
nbclassic==0.4.6
nbclient==0.5.13
nbconvert==7.2.1
nbformat==5.7.0
Expand Down Expand Up @@ -115,6 +116,8 @@ prompt-toolkit==3.0.31
psutil==5.9.2
ptyprocess==0.7.0
py==1.11.0
pybtex==0.24.0
pybtex-docutils==1.0.2
pycparser==2.21
pydantic==1.10.2
pydata-sphinx-theme==0.8.1
Expand Down Expand Up @@ -146,6 +149,7 @@ sphinx-copybutton==0.5.0
sphinx-design==0.3.0
sphinx-togglebutton==0.3.2
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-bibtex==2.5.0
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
Expand Down
10 changes: 7 additions & 3 deletions .constraints/py3.8.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jinja2==3.1.2
json5==0.9.10
jsonschema==4.16.0
jupyter-cache==0.5.0
jupyter-client==7.4.1
jupyter-client==7.4.2
jupyter-core==4.11.1
jupyter-server==1.21.0
jupyterlab==3.4.8
Expand All @@ -75,6 +75,7 @@ jupyterlab-server==2.15.2
jupyterlab-widgets==3.0.3
kaleido==0.2.1
kiwisolver==1.4.4
latexcodec==2.0.1
livereload==2.6.3
lxml==4.9.1
markdown-it-py==2.1.0
Expand All @@ -88,7 +89,7 @@ mpmath==1.2.1
mypy-extensions==0.4.3
myst-nb==0.17.1
myst-parser==0.18.1
nbclassic==0.4.5
nbclassic==0.4.6
nbclient==0.5.13
nbconvert==7.2.1
nbformat==5.7.0
Expand All @@ -97,7 +98,7 @@ nest-asyncio==1.5.6
nodeenv==1.7.0
notebook==6.4.12
notebook-shim==0.1.0
numpy==1.23.3
numpy==1.23.4
opt-einsum==3.3.0
packaging==21.3
pandas==1.5.0
Expand All @@ -119,6 +120,8 @@ psutil==5.9.2
ptyprocess==0.7.0
pure-eval==0.2.2
py==1.11.0
pybtex==0.24.0
pybtex-docutils==1.0.2
pycparser==2.21
pydantic==1.10.2
pydata-sphinx-theme==0.8.1
Expand Down Expand Up @@ -149,6 +152,7 @@ sphinx-copybutton==0.5.0
sphinx-design==0.3.0
sphinx-togglebutton==0.3.2
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-bibtex==2.5.0
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
Expand Down
10 changes: 7 additions & 3 deletions .constraints/py3.9.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jinja2==3.1.2
json5==0.9.10
jsonschema==4.16.0
jupyter-cache==0.5.0
jupyter-client==7.4.1
jupyter-client==7.4.2
jupyter-core==4.11.1
jupyter-server==1.21.0
jupyterlab==3.4.8
Expand All @@ -75,6 +75,7 @@ jupyterlab-server==2.15.2
jupyterlab-widgets==3.0.3
kaleido==0.2.1
kiwisolver==1.4.4
latexcodec==2.0.1
livereload==2.6.3
lxml==4.9.1
markdown-it-py==2.1.0
Expand All @@ -88,7 +89,7 @@ mpmath==1.2.1
mypy-extensions==0.4.3
myst-nb==0.17.1
myst-parser==0.18.1
nbclassic==0.4.5
nbclassic==0.4.6
nbclient==0.5.13
nbconvert==7.2.1
nbformat==5.7.0
Expand All @@ -97,7 +98,7 @@ nest-asyncio==1.5.6
nodeenv==1.7.0
notebook==6.4.12
notebook-shim==0.1.0
numpy==1.23.3
numpy==1.23.4
opt-einsum==3.3.0
packaging==21.3
pandas==1.5.0
Expand All @@ -118,6 +119,8 @@ psutil==5.9.2
ptyprocess==0.7.0
pure-eval==0.2.2
py==1.11.0
pybtex==0.24.0
pybtex-docutils==1.0.2
pycparser==2.21
pydantic==1.10.2
pydata-sphinx-theme==0.8.1
Expand Down Expand Up @@ -148,6 +151,7 @@ sphinx-copybutton==0.5.0
sphinx-design==0.3.0
sphinx-togglebutton==0.3.2
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-bibtex==2.5.0
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
Expand Down
3 changes: 3 additions & 0 deletions .cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
],
"ignorePaths": [
"**/.cspell.json",
"*.bib",
".constraints/*.txt",
".cspell/*.txt",
".gitignore",
Expand Down Expand Up @@ -112,13 +113,15 @@
"Sigmapi",
"hangle",
"lc2pkpi",
"mystnb",
"nbsp",
"prereleased",
"rgba",
"shared_yaxes",
"tableofcontents",
"textbf",
"tickvals",
"unsrt",
"xaxes",
"xaxis",
"xshift",
Expand Down
7 changes: 6 additions & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ repos:
- id: check-yaml
- id: debug-statements
- id: end-of-file-fixer
exclude: >
(?x)^(
.*\.bib|
.*\.svg
)$
- id: mixed-line-ending
- id: trailing-whitespace

Expand Down Expand Up @@ -74,7 +79,7 @@ repos:
- id: prettier

- repo: https://github.com/ComPWA/mirrors-pyright
rev: v1.1.274
rev: v1.1.275
hooks:
- id: pyright

Expand Down
1 change: 1 addition & 0 deletions .vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"recommendations": [
"ExecutableBookProject.myst-highlight",
"bungcip.better-toml",
"eamodio.gitlens",
"editorconfig.editorconfig",
Expand Down
14 changes: 14 additions & 0 deletions docs/_static/references.bib
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

@book{Cornwell:1997ke,
title = {Group {{Theory}} in {{Physics}}: {{An Introduction}}},
shorttitle = {Group Theory in Physics},
author = {Cornwell, J. F.},
year = {1997},
publisher = {{Academic Press}},
address = {{San Diego, Calif}},
isbn = {978-0-12-189800-7},
langid = {english},
lccn = {530.152 2}
}


2 changes: 1 addition & 1 deletion docs/appendix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
```{toctree}
appendix/dynamics
appendix/angles
appendix/rotation-matrix
appendix/phase-space
appendix/alignment
appendix/benchmark
appendix/serialization
appendix/ls-model
appendix/homomorphism
```
Loading