Skip to main content

A collection of Sphinx extensions

Project description

Rusty is a collection of Sphinx extensions - namely roles and directives.

Features

At the moment, the Rusty contains following extensions:

rolelist

Generates list from the selected set of role entires, written into document. This might come handy for example with release notes where bug entries (marked with role syntax) are listed automatically:

Bug fixes
=========

.. rolelist:: bug
   :levelsup: 1
   :template: #${value}: ${text}
   :siblings:

Changes
=======

* Fixed :bug:`application crashes <235>` -issue
* Fixed :bug:`application fails to load document <236>` -issue
includesh

Includesh (or include shell) extends the basic functionality of include directive: instead of just including the contents of the file into document, the includesh transforms the shell comments into documents and commands into literal blocks:

This section lists down the installation step from the setup.sh:

.. includesh:: setup.sh

Installation

The easiest way to install the package is to use easy_install:

easy_install -U rusty

Alternative method is to download the package manually, extract it and install it using traditional methods:

sudo python setup.py install

Documentation

Documentation provides further information and examples how to use the module. There exists two resources:

Source/issue management

Both software sources and issues can be accessed via Bitbucket

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rusty-0.1.0.tar.gz (99.3 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page