Skip to main content

Sphinx role for linking to PDG reviews and listing

Project description

PDG role for Sphinx

PyPI package Supported Python versions GPLv3+ license GitPod Test coverage Codacy Badge CI status Checked with mypy pre-commit.ci status Spelling checked code style: prettier Code style: black Imports: isort

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 sphinxcontrib-hep-pdgref

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

extensions = [
    # ...
    "sphinxcontrib.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!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-hep-pdgref-0.1.4.tar.gz (20.0 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page