Sphinx extension for PyPI
Project description
Ah! We do have some Camembert, sir…
This extension adds directives for easy linking to Cheese Shop (Python Package Index) packages. It requires Sphinx 4.0.
It’s a bit runny, sir…
It supports a directive and a role, as well as a new config value.
Well, as a matter of fact it’s very runny, sir…
The pypi-release directive adds an HTML-only output block that automatically fetches the download links for the latest release of the given package and displays them as a list. For example,
.. pypi-release:: Sphinx :prefix: Download :class: sidebar
will display “Download:” and a list of download links (eggs and the source distribution) for the latest Sphinx release. The “sidebar” class makes the resulting <div> appear like a reStructuredText sidebar. Using “prefix”, you can select what text precedes the list.
I think it’s runnier than you like it, sir…
The pypi role links to a package. Use it in one of these forms:
:pypi:`Sphinx` -- link to latest release :pypi:`the Sphinx package <Sphinx>` -- dito, but explicit title given :pypi:`Sphinx (0.6)` -- link to specific release :pypi:`the Sphinx package <Sphinx (0.6)>` -- dito, with explicit title
This extension also adds a cheeseshop_url config value, which defaults to 'http://pypi.org/project' and is used to build URLs to the Cheese Shop.
Have fun!
Oh… The cat’s eaten it.
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
Hashes for sphinxcontrib_cheeseshop-0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce61e740417be77a7ec728471fb8561dac9849465ce9a964c0aab0dc9a62352b |
|
MD5 | 0b91bedb0c95d3388046548d9f1931e1 |
|
BLAKE2b-256 | 9b382041ac24bc73b7bcd6728d807a779b66bf9e0204301c0b31101cffeecf87 |
Hashes for sphinxcontrib_cheeseshop-0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b4fb43b10266734c02bc5e6f401a73585824c467671b60d119a58428daf0bcd |
|
MD5 | 401d44c564ed3ce86f987bfec97f4c4b |
|
BLAKE2b-256 | c49eb552a328c3a672ffd398924ad35b1aa502ba84d625ebd2495ab6aad3b324 |