Sphinx role for linking to PDG reviews and listing
Project description
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 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:
Note that the resulting links lead to the correct page as well!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinxcontrib-hep-pdgref-0.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bbf6aefe9e111acc80b79e7ccd5c62077d760cef15bb3a43fe5895a125f5f04 |
|
MD5 | a07c0ac927ad8754715510bbd51b2302 |
|
BLAKE2b-256 | 064526581aded3c2c24986cc47cabd26a4bc8a31b4ae5d140ae6ba88618c7c4d |
Close
Hashes for sphinxcontrib_hep_pdgref-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 480f14ba4917d59ec6753a67477125d5568df00e2733c44f8e2aeac7b0309b5a |
|
MD5 | aea0e19ba16afc19a805f8477ddcc9fd |
|
BLAKE2b-256 | a4abd18807e6922fe4a4a9cb89af09aa507c992561ddead4ea313cc3434840d4 |