https://github.com/sphinx-contrib/cheeseshop

https://github.com/sphinx-contrib/cheeseshop

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/sphinx-contrib/cheeseshop
• Owner: sphinx-contrib
• License: bsd-2-clause
• Created: 2017-09-28T10:30:40.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-26T06:25:13.000Z (over 1 year ago)
• Last Synced: 2025-04-07T15:01:32.697Z (about 1 month ago)
• Language: Python
• Size: 12.7 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst

Awesome Lists containing this project

README

        
================================

The Cheese Shop Sphinx extension

================================

   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 ``
`` 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 `  -- dito, but explicit title given

   :pypi:`Sphinx (0.6)`  -- link to specific release

   :pypi:`the Sphinx package `  -- 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.