{"id":18952695,"url":"https://github.com/compwa/sphinx-hep-pdgref","last_synced_at":"2025-07-20T22:06:10.304Z","repository":{"id":42448149,"uuid":"356860301","full_name":"ComPWA/sphinx-hep-pdgref","owner":"ComPWA","description":"Sphinx role for linking to PDG reviews and listing","archived":false,"fork":false,"pushed_at":"2025-04-07T21:07:50.000Z","size":123,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-07-06T15:46:10.881Z","etag":null,"topics":["particle-listings","pdg","restructuredtext","sphinx"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ComPWA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-04-11T12:21:53.000Z","updated_at":"2025-01-29T15:18:35.000Z","dependencies_parsed_at":"2024-11-08T13:39:58.909Z","dependency_job_id":"d3164c8c-7f24-47bd-8f9f-6880d4044461","html_url":"https://github.com/ComPWA/sphinx-hep-pdgref","commit_stats":null,"previous_names":["compwa/sphinxcontrib-hep-pdgref"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/ComPWA/sphinx-hep-pdgref","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComPWA%2Fsphinx-hep-pdgref","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComPWA%2Fsphinx-hep-pdgref/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComPWA%2Fsphinx-hep-pdgref/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComPWA%2Fsphinx-hep-pdgref/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ComPWA","download_url":"https://codeload.github.com/ComPWA/sphinx-hep-pdgref/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComPWA%2Fsphinx-hep-pdgref/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266205052,"owners_count":23892389,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["particle-listings","pdg","restructuredtext","sphinx"],"created_at":"2024-11-08T13:34:20.579Z","updated_at":"2025-07-20T22:06:10.280Z","avatar_url":"https://github.com/ComPWA.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PDG role for Sphinx\n\n[![PyPI package](https://badge.fury.io/py/sphinx-hep-pdgref.svg)](https://pypi.org/project/sphinx-hep-pdgref)\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/sphinx-hep-pdgref)](https://pypi.org/project/sphinx-hep-pdgref)\n[![BSD 3-Clause license](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)\n[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/sphinx-hep-pdgref)\n[![Test coverage](https://codecov.io/gh/ComPWA/sphinx-hep-pdgref/branch/main/graph/badge.svg?token=SS8ZB8J11N)](https://codecov.io/gh/ComPWA/sphinx-hep-pdgref)\n[![CI status](https://github.com/ComPWA/sphinx-hep-pdgref/workflows/CI-tests/badge.svg)](https://github.com/ComPWA/sphinx-hep-pdgref/actions?query=branch%3Amain+workflow%3ACI-tests)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy.readthedocs.io)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/sphinx-hep-pdgref/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/sphinx-hep-pdgref/main)\n[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](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\u003e [PDG2020](https://pdg.lbl.gov/2020/listings/rpp2020-list-K-zero.pdf)\n\u003e\n\u003e [PDG2020, §Kinematics](https://pdg.lbl.gov/2020/reviews/rpp2020-rev-kinematics.pdf)\n\u003e\n\u003e [PDG2014, §Resonances](https://pdg.lbl.gov/2014/reviews/rpp2014-rev-resonances.pdf)\n\u003e\n\u003e [PDG2018, §Resonances, pp.2-4,7](https://pdg.lbl.gov/2018/reviews/rpp2018-rev-resonances.pdf#page=2)\n\u003e\n\u003e [PDG2020, §QCD, p.5](https://pdg.lbl.gov/2020/reviews/rpp2020-rev-qcd.pdf#page=5)\n\u003e\n\u003e [PDG2015, §Quark 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompwa%2Fsphinx-hep-pdgref","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompwa%2Fsphinx-hep-pdgref","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompwa%2Fsphinx-hep-pdgref/lists"}