Sphinx 0.2 released

Georg Brandl georg at python.org
Sun Apr 27 22:19:09 CEST 2008


I'm pleased to announce the release 0.2 of Sphinx, the Python documentation
generation tool. There were some intermediate smaller releases in the 0.1
series, but for 0.2 there are quite a lot new features and fixes.

What is it?
===========

Sphinx is a tool that makes it easy to create intelligent and beautiful
documentation for Python projects (or other documents consisting of
multiple reStructuredText source files).

Its website is at <http://sphinx.pocoo.org/>.


Partial list of changes
=======================
(full list at http://sphinx.pocoo.org/changes.html)

* Support a new extension method, ``add_crossref_type``.  It works like
   ``add_description_unit`` but the directive will only create a target
   and no output.
* Support a new extension method, ``add_transform``.  It takes a standard
   docutils ``Transform`` subclass which is then applied by Sphinx' reader on
   parsing reST document trees.
* Add support for other template engines than Jinja, by adding an
   abstraction called a "template bridge".
* The config file itself can be an extension (if it provides a ``setup()``
   function).

* New directive, ``currentmodule``.  It can be used to indicate the module
   name of the following documented things without creating index entries.
* Allow giving a different title to documents in the toctree.
* Allow giving multiple options and long options in a ``cmdoption`` directive.
* Fix display of class members without explicit class name given.

* There's a new config value, ``html_title``, that controls the overall
   "title" of the set of Sphinx docs.  It is used instead everywhere instead of
   "Projectname vX.Y documentation" now.
* All references to "documentation" in the templates have been removed, so
   that it is now easier to use Sphinx for non-documentation documents with
   the default templates.
* You can now create an OpenSearch description file with the
   ``html_use_opensearch`` config value.
* You can now quickly include a logo in the sidebar, using the ``html_logo``
   config value.

* You can include a logo in the title page with the ``latex_logo`` config
   value.
* You can define the link colors and a border and background color for
   verbatim environments.

Enjoy!
Georg


More information about the Python-announce-list mailing list