This package is a Sphinx extension that makes it easy to refer to PDF files of reviews and particle listings in the PDG.
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",
# ...
]
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:
Note that the resulting links lead to the correct page as well!
FAQs
Sphinx role for linking to PDG reviews and listing
We found that sphinx-hep-pdgref demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.