No project description provided
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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 162945a99271d4dcb6ed9e9247e282ba92a39985955930452fc046149828fc02 |
|
MD5 | df447cfb2dfa8c43c231bc1aea1ca87c |
|
BLAKE2b-256 | 17990379cec997fdc205be3e8961513cf27002f736cc7b0aa85d4af564482c2a |
Close
Hashes for sphinxcontrib_hep_pdgref-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a66f88078a6cb9bf9f54f4881d2ddf3daa94d162259d1aa72d03e5cc945b0d6 |
|
MD5 | 0523fd4ccdc361fd3d07758dd853a8b1 |
|
BLAKE2b-256 | 98f270cb68af3d50902ea2b8694119ad98de1cce355b1caebeb83872e6f92887 |