README.md

PDG role for Sphinx

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!