sphinx-contrib / cheeseshop /

Filename Size Date modified Message
..
sphinxcontrib
227 B
49 B
1.5 KB
81 B
1.0 KB
================================
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 1.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.python.org/pypi'`` and is used to build URLs to the Cheese Shop.

Have fun!

   Oh... The cat's eaten it.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.