# PDG role for Sphinx
[](https://pypi.org/project/sphinx-hep-pdgref)
[](https://pypi.org/project/sphinx-hep-pdgref)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://open.vscode.dev/ComPWA/sphinx-hep-pdgref)
[](https://codecov.io/gh/ComPWA/sphinx-hep-pdgref)
[](https://www.codacy.com/gh/ComPWA/sphinx-hep-pdgref)
[](https://github.com/ComPWA/sphinx-hep-pdgref/actions?query=branch%3Amain+workflow%3ACI-tests)
[](https://mypy.readthedocs.io)
[](https://results.pre-commit.ci/latest/github/ComPWA/sphinx-hep-pdgref/main)
[](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
[](https://github.com/prettier/prettier)
[](https://github.com/astral-sh/ruff)
[](https://github.com/astral-sh/uv)
This package is a
[Sphinx extension](https://www.sphinx-doc.org/en/master/usage/extensions/index.html)
that makes it easy to refer to PDF files of reviews and particle listings in the PDG.
## Installation
Just install through [PyPI](https://pypi.org) with `pip`:
```bash
pip install sphinx-hep-pdgref
```
Next, in your
[Sphinx configuration file](https://www.sphinx-doc.org/en/master/usage/configuration.html)
(`conf.py`), add `"sphinx_hep_pdgref"` to your `extensions`:
```python
extensions = [
# ...
"sphinx_hep_pdgref",
# ...
]
```
## Usage
There are two roles, one for the
[particle listings](https://pdg.lbl.gov/2020/listings/contents_listings.html) and one
for the [review](https://pdg.lbl.gov/2020/reviews/contents_sports.html). These roles can
be used as follows:
```restructuredtext
:pdg-listing:`K-zero`
:pdg-review:`Kinematics`
:pdg-review:`2014; Resonances`
:pdg-review:`Resonances; 2018; pp. 2-4, 7`
:pdg-review:`QCD; p5`
:pdg-review:`PDG2015; Quark Model; p.2`
```
which will render in the HTML pages as:
> [PDG2020](https://pdg.lbl.gov/2020/listings/rpp2020-list-K-zero.pdf)
>
> [PDG2020, §Kinematics](https://pdg.lbl.gov/2020/reviews/rpp2020-rev-kinematics.pdf)
>
> [PDG2014, §Resonances](https://pdg.lbl.gov/2014/reviews/rpp2014-rev-resonances.pdf)
>
> [PDG2018, §Resonances, pp.2-4,7](https://pdg.lbl.gov/2018/reviews/rpp2018-rev-resonances.pdf#page=2)
>
> [PDG2020, §QCD, p.5](https://pdg.lbl.gov/2020/reviews/rpp2020-rev-qcd.pdf#page=5)
>
> [PDG2015, §Quark Model, p.2](https://pdg.lbl.gov/2015/reviews/rpp2015-rev-qcd.pdf#page=2)
_Note that the resulting links lead to the correct page as well!_
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-hep-pdgref",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "compwa-admin@ep1.rub.de",
"keywords": "particle data group, pdg, reference, sphinx",
"author": null,
"author_email": "Common Partial Wave Analysis <compwa-admin@ep1.rub.de>",
"download_url": "https://files.pythonhosted.org/packages/78/22/37fed67271c83018cea4c5c8f82b03d658cac6407289dca5a7cb3ed4b600/sphinx_hep_pdgref-0.2.1.tar.gz",
"platform": null,
"description": "# PDG role for Sphinx\n\n[](https://pypi.org/project/sphinx-hep-pdgref)\n[](https://pypi.org/project/sphinx-hep-pdgref)\n[](https://opensource.org/licenses/BSD-3-Clause)\n[](https://open.vscode.dev/ComPWA/sphinx-hep-pdgref)\n[](https://codecov.io/gh/ComPWA/sphinx-hep-pdgref)\n[](https://www.codacy.com/gh/ComPWA/sphinx-hep-pdgref)\n[](https://github.com/ComPWA/sphinx-hep-pdgref/actions?query=branch%3Amain+workflow%3ACI-tests)\n[](https://mypy.readthedocs.io)\n[](https://results.pre-commit.ci/latest/github/ComPWA/sphinx-hep-pdgref/main)\n[](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)\n[](https://github.com/prettier/prettier)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/astral-sh/uv)\n\nThis package is a\n[Sphinx extension](https://www.sphinx-doc.org/en/master/usage/extensions/index.html)\nthat makes it easy to refer to PDF files of reviews and particle listings in the PDG.\n\n## Installation\n\nJust install through [PyPI](https://pypi.org) with `pip`:\n\n```bash\npip install sphinx-hep-pdgref\n```\n\nNext, in your\n[Sphinx configuration file](https://www.sphinx-doc.org/en/master/usage/configuration.html)\n(`conf.py`), add `\"sphinx_hep_pdgref\"` to your `extensions`:\n\n```python\nextensions = [\n # ...\n \"sphinx_hep_pdgref\",\n # ...\n]\n```\n\n## Usage\n\nThere are two roles, one for the\n[particle listings](https://pdg.lbl.gov/2020/listings/contents_listings.html) and one\nfor the [review](https://pdg.lbl.gov/2020/reviews/contents_sports.html). These roles can\nbe used as follows:\n\n```restructuredtext\n:pdg-listing:`K-zero`\n\n:pdg-review:`Kinematics`\n\n:pdg-review:`2014; Resonances`\n\n:pdg-review:`Resonances; 2018; pp. 2-4, 7`\n\n:pdg-review:`QCD; p5`\n\n:pdg-review:`PDG2015; Quark Model; p.2`\n```\n\nwhich will render in the HTML pages as:\n\n> [PDG2020](https://pdg.lbl.gov/2020/listings/rpp2020-list-K-zero.pdf)\n>\n> [PDG2020, \u00a7Kinematics](https://pdg.lbl.gov/2020/reviews/rpp2020-rev-kinematics.pdf)\n>\n> [PDG2014, \u00a7Resonances](https://pdg.lbl.gov/2014/reviews/rpp2014-rev-resonances.pdf)\n>\n> [PDG2018, \u00a7Resonances, pp.2-4,7](https://pdg.lbl.gov/2018/reviews/rpp2018-rev-resonances.pdf#page=2)\n>\n> [PDG2020, \u00a7QCD, p.5](https://pdg.lbl.gov/2020/reviews/rpp2020-rev-qcd.pdf#page=5)\n>\n> [PDG2015, \u00a7Quark Model, p.2](https://pdg.lbl.gov/2015/reviews/rpp2015-rev-qcd.pdf#page=2)\n\n_Note that the resulting links lead to the correct page as well!_\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Sphinx role for linking to PDG reviews and listing",
"version": "0.2.1",
"project_urls": {
"Changelog": "https://github.com/ComPWA/sphinx-hep-pdgref/releases",
"Documentation": "https://github.com/ComPWA/sphinx-hep-pdgref/blob/main/README.md",
"Source": "https://github.com/ComPWA/sphinx-hep-pdgref",
"Tracker": "https://github.com/ComPWA/sphinx-hep-pdgref/issues"
},
"split_keywords": [
"particle data group",
" pdg",
" reference",
" sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d0c78ba08f0f2c3f8980b07a0b74b411ef6f6ef662f3b0517b1cd922cfc66a4",
"md5": "8cf4ccf3f40e5b1bf99141ea85c4bcae",
"sha256": "4d22a3cd7278b6be8988559acd8c15573cb482a0e686172a25899a53d64a6127"
},
"downloads": -1,
"filename": "sphinx_hep_pdgref-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8cf4ccf3f40e5b1bf99141ea85c4bcae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7534,
"upload_time": "2024-10-29T10:57:08",
"upload_time_iso_8601": "2024-10-29T10:57:08.628825Z",
"url": "https://files.pythonhosted.org/packages/9d/0c/78ba08f0f2c3f8980b07a0b74b411ef6f6ef662f3b0517b1cd922cfc66a4/sphinx_hep_pdgref-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "782237fed67271c83018cea4c5c8f82b03d658cac6407289dca5a7cb3ed4b600",
"md5": "9b76d02a1cec232ec440fd815892a1ba",
"sha256": "c7cbae1ea1d7b70a82872a99583ebad7886c3ed217b5610ead8446843699f6d8"
},
"downloads": -1,
"filename": "sphinx_hep_pdgref-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "9b76d02a1cec232ec440fd815892a1ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 17614,
"upload_time": "2024-10-29T10:57:09",
"upload_time_iso_8601": "2024-10-29T10:57:09.522949Z",
"url": "https://files.pythonhosted.org/packages/78/22/37fed67271c83018cea4c5c8f82b03d658cac6407289dca5a7cb3ed4b600/sphinx_hep_pdgref-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 10:57:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ComPWA",
"github_project": "sphinx-hep-pdgref",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-hep-pdgref"
}
JSON
