rusty 0.3.1
A collection of Sphinx extensions
License: MIT

Rusty is a collection of extensions (directives and roles)
for `Sphinx documentation framework <http://sphinx.pocoo.org/>`_. While
the extensions are somewhat compatible with `docutils
<http://docutils.sourceforge.net>`_,
the usage of *Sphinx is currently required*.

.. contents::

Features
========
At the moment, the Rusty contains the extensions listed beneath. Ideas for new
extension can been suggested in `BitBucket <http://bitbucket.org/jmu/rusty>`_

`exceltable`_
-------------
Include data from excelsheets into documentation.

`rolelist`_
-----------
Generates list from the selected set of role entires, written into document.


`includesh`_
------------
Include shell scripts into documentation: comments as documentation and
commands as literal blocks.


`regxlist`_
-----------
Similar to rolelist directive. The main difference is the
capability to create list based on regular expression rule.

`xmltable`_
-----------
Similar functionality to csv-table - one of the docutils directives: read data
from XML/HTML file and convert it to RST-table based on given query and iterator.
Requires BeautifulSoup -module.


.. _exceltable: http://packages.python.org/rusty/exceltable.html
.. _includesh: http://packages.python.org/rusty/includesh.html
.. _xmltable: http://packages.python.org/rusty/xmltable.html
.. _regxlist: http://packages.python.org/rusty/regxlist.html
.. _rolelist: http://packages.python.org/rusty/rolelist.html


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:

* `Official documentation <http://packages.python.org/rusty>`_
* `Nightly build from trunk <http://jmu.koodiorja.com/projects/rusty>`_

Changelog
=========

Release 0.3.1 (2009-08-08)
------------------------------
Changes since 0.3.0 release:

* Fixed issue: exceltable selector does not work with numbers containing zero

Release 0.3.0 (2009-07-07)
------------------------------
Changes since 0.2.0 release:

* Added new directive: rusty.exceltable - for including the excelsheets data
  into documentation
* Improved XMLTable documentation
* Fixed issue: xmltable does not stop processing even if file or query is missing
* Fixed issue #4: setup.py and paver-minilib.zip is missing from the package

Release 0.2.2 (2009-06-18)
------------------------------
Maintenance release, containing following changes:

* Fixed issue #4 again: paver-minilib.zip is missing from the package

Release 0.2.1 (2009-06-16)
------------------------------
Maintenance release, containing following changes:

* Fixed issue #4: setup.py is missing from the package

Release 0.2.0 (2009-06-01)
------------------------------
Changes since previous release:

* New directive: xmltable
* New directive: regxlist
* Improved unit testing
* Improved building
* Migrated version control from subversion to mercurial
* Published the project in Bitbucket: http://bitbucket.org/jmu/rusty
* Added FAQ

Release 0.1.0 (2009-03-31)
--------------------------
First release, containing following functionality

* New directive: includesh
* New directive: rolelist
* Initial set of unit tests (see testing)
* Paver powered build and release management