Skip to main content

PDG role for Sphinx

PyPI package Supported Python versions BSD 3-Clause license Open in Visual Studio Code Test coverage CI status pre-commit.ci status Spelling checked code style: prettier Ruff uv ty

This package is a Sphinx extension that makes it easy to refer to PDF files of reviews and particle listings in the PDG.

Installation

Just install through PyPI with pip:

pip install sphinx-hep-pdgref

Next, in your Sphinx configuration file (conf.py), add "sphinx_hep_pdgref" to your extensions:

extensions = [
    # ...
    "sphinx_hep_pdgref",
    # ...
]

Usage

There are two roles, one for the particle listings and one for the review. These roles can be used as follows:

: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

PDG2020, §Kinematics

PDG2014, §Resonances

PDG2018, §Resonances, pp.2-4,7

PDG2020, §QCD, p.5

PDG2015, §Quark Model, p.2

Note that the resulting links lead to the correct page as well!

Release files for sphinx-hep-pdgref 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-hep-pdgref 0.2.2
File Size Uploaded
sphinx_hep_pdgref-0.2.2.tar.gz 17.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-hep-pdgref 0.2.2
File Interpreter ABI Platform
sphinx_hep_pdgref-0.2.2-py3-none-any.whl Python 3 none any Details

Total release size: 24.8 kB

Release files / sphinx_hep_pdgref-0.2.2.tar.gz

Download URL sphinx_hep_pdgref-0.2.2.tar.gz
Size 17.3 kB
Tags Source
SHA-256 checksum
How to use checksums
1257b50628bca25219112fca2ec3a5ab881c82b0cdc50be73eb56b2400c5ec2e
BLAKE2b-256 checksum
How to use checksums
2e376a0e669bec2089db62e78c51900138fa1ea11cc51c8dc1ce433e1cb261af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 6, 2026.

Transparency log

Release files / sphinx_hep_pdgref-0.2.2-py3-none-any.whl

Download URL sphinx_hep_pdgref-0.2.2-py3-none-any.whl
Size 7.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3b990e16ac449f967c2e54cbbeffdc9fda380e4112e9de9aac0fdc0aea285915
BLAKE2b-256 checksum
How to use checksums
721efbdfe0b6131ac0d2b62052f2f44a48c8f02434ce16cef4383fcaad4fe5cf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 6, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.2.2 This release

2 release files

0.2.1

2 release files

0.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page