Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

pypm install z3c.recipe.sphinxdoc

How to install z3c.recipe.sphinxdoc

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install z3c.recipe.sphinxdoc
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
1.0.0Never BuiltWhy not?
0.0.8 Available View build log
Windows (64-bit)
1.0.0Never BuiltWhy not?
0.0.8 Available View build log
Mac OS X (10.5+)
1.0.0Never BuiltWhy not?
0.0.8 Available View build log
Linux (32-bit)
1.0.0 Available View build log
0.0.8 Available View build log
Linux (64-bit)
1.0.0 Available View build log
0.0.8 Available View build log
1.0.0 Available View build log
ZPL 2.1
Lastest release
version 1.0.0 on Mar 3rd, 2013


This buildout recipe aids in the generation of documentation for the zope.org website from restructured text files located in a package. It uses Sphinx to build static html files which can stand alone as a very nice looking website.

Usage Instructions

Suppose you have a package called z3c.form. In the setup.py for z3c.form it is recommended that you add a docs section to the extras_require argument. It should look something like this:

extras_require = dict(
    docs = ['Sphinx',

Then in the buildout.cfg file for your package, add a docs section that looks like this:

recipe = z3c.recipe.sphinxdoc
eggs = z3c.form [docs]

Be sure to include it in the parts, as in:

develop = .
parts = docs

Now you can rerun buildout. The recipe will have created an executable script in the bin directory called docs.

This script will run the Sphinx documentation generation tool on your source code. By default, it expects there to be an index.txt file in the source code. In this case, index.txt would have to be in src/z3c/form/index.txt. This file can be a standard restructured text file, and can use all the sphinx goodies. For example, your index.txt might look like this:

Welcome to z3c.form's documentation!


.. toctree::
   :maxdepth: 2


Indices and tables

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

You should read the documentation for Sphinx to learn more about it. It is available here: http://sphinx.pocoo.org/

Now you should be able to run the docs script:

$ ./bin/docs

This generates all the documentation for you and placed it in the parts directory. You can then open it up in firefox and take a look:

$ firefox parts/docs/z3c.form/build/index.html

Additional Options

By default, this recipe generates documentation that looks like the new zope website ( http://new.zope.org ) by ovveriding the default layout template and css file used by sphinx. You can modify this behavior with options in your buildout configuration.

Give me back Sphinx's default look!

To get back the default look of sphinx, you could use a configuration like this:

recipe = z3c.recipe.sphinxdoc
eggs = z3c.form [docs]
default.css =
layout.html =
I want my own custom look

You can also specify your own layout template and css like so:

recipe = z3c.recipe.sphinxdoc
eggs = z3c.form [docs]
default.css = http://my.own.website.com/mystyles/some-theme.css
layout.html = /path/to/layout.html

Note that you can either specify a path on the local file system or a url to an external css file.

Use sphinx extension modules

Sphinx provides a set of extensions, for example sphinx.ext.autodoc or sphinx.ext.doctest. To use such an extension change your configuration like:

recipe = z3c.recipe.sphinxdoc
eggs = z3c.form [docs]
extensions = sphinx.ext.autodoc sphinx.ext.doctest

1.0.0 (2013-02-23)

  • Added Python 3.3 support.
  • Bug: fix layout directory if layout is overriden by user

0.0.8 (2009-05-01)

  • Feature: Added new option doc-eggs which specifies the list of eggs for which to create documentation explicitely.
  • Feature: Changed building behavior so that the documentation for each package is built in its own sub-directory.
  • Feature: Added new option extensions which takes a whitespace separated list of sphinx extension modules. This extensions can be used to build the documentation.

0.0.7 (2009-02-15)

  • Bug: fix python 2.4 support
  • Bug: fix broken srcDir path generation for windows

0.0.6 (2009-01-19)

  • Feature: Allow you to specify a url or local file path to your own default.css and layout.html files.

0.0.5 (2008-05-11)

  • Initial release.

Subscribe to package updates

Last updated Mar 3rd, 2013

Download Stats

Last month:1

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.