skip to navigation
skip to content

collective.recipe.sphinxbuilder 0.1.1

ZC.buildout recipe to generate and build Sphinx-based documentation in the buildout.

Latest Version: 1.0

Detailed Documentation

What is Sphinx ?

Sphinx is the rising tool in the Python community to build documentation. See

It is now used for instance by Python. See

Sphinx uses reStructuredText, and can be used to write your buildout-based application. This recipe sets everything up for you, so you can provide a nice-looking documentation within your buildout, in static html or even PDF.

The fact that your documentation is managed like your code makes it easy to maintain and change it.

Quick start

To use the recipe, add in your buildout configuration file a section like this:

parts =

recipe = collective.recipe.sphinxbuilder

That’s it ! Run your buildout and you will get:

  • a new script in the bin folder, called sphinx
  • a docs directory containing your documentation.

To build your documentation, just run the sphinx script:

$ bin/sphinx

You will get a shiny Sphinx documenation in docs/build/html. To write your documentation, go in docs/source. Everytime source is modified, run the script again.

A good starting point to write your documentation is:

Supported options

The recipe supports the following options:

Specify the documentation root. Default to docs.
Multiple-line value that defines what kind of output to produce. Can be html, latex or pdf. Defaults to html.
The name of the script generated. Defaults to the name of the section.
The name of the project used in Plone. Defaults to Plone.
Sphinx extensions in use. Defaults to none.
Name of the index file. Defaults to index.
Year of the project. Defaults to current year.
File extensions used for reST file. Defaults to .txt
Author. Defaults to Plone Community.
Version. Defaults to 1.0.
Release. Defaults to 1.0.
The prefix of the static and template directory. Defaults to ‘.’ under Linux and ‘_’ under Windows.
Separate source and build directories. (Y or N) Defaults to Yes.
Logo used for html and pdf. Defaults to plone.png (which is provided by the recipe)
css file used to change Sphinx look. Defaults to plone.css (which is provided by the recipe)
extra latex options file used in Sphinx. Defaults to options.tex provided by the recipe.

Example usage

The recipe can be used without any options. We’ll start by creating a buildout that uses the recipe:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = sphinx
... [sphinx]
... recipe = collective.recipe.sphinxbuilder
... """)

Let’s run the buildout:

>>> print 'start', system(buildout)
Installing sphinx.
Generated script '/sample-buildout/bin/sphinx-build'.

What are we expecting ?

A docs folder with a Sphinx structure:

>>> docs = join(sample_buildout, 'docs')
>>> ls(docs)
- Makefile
d source

>>> source = join(docs, 'source')
>>> ls(source)
d  .static
d  .templates
-  index.txt

>>> ls(join(source, '.templates'))
-  layout.html
-  modindex.html
-  search.html

>>> ls(join(source, '.static'))
-  options.tex
-  plone.css
-  plone_logo.png

A script in the bin folder to build the docs:

>>> bin = join(sample_buildout, 'bin')
>>> ls(bin)
- buildout
- sphinx
- sphinx-build

The content of the script is a simple shell script:

>>> script = join(sample_buildout, 'bin', 'sphinx')
>>> print open(script).read()
make html

If we want latex and pdf, we need to explicitly define it:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = sphinx
... [sphinx]
... recipe = collective.recipe.sphinxbuilder
... doc-outputs =
...     html
...     latex
...     pdf
... """)
>>> print 'start', system(buildout)
Installing sphinx.

Let’s see our script now:

>>> print open(script).read()
make html
make latex
make latex && cd ... && make

Finally let’s run it:

>>> print 'start', system(script)
start mkdir -p build/html build/doctrees
Transcript written in modPlone.ilg.

We should have some nice reST file:

>>> print open(join(docs, 'source', 'index.txt')).read()
.. Plone documentation master file, ...
Welcome to Plone's documentation!
.. toctree::
   :maxdepth: 2
Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

And the html rendering should use the plone logo:

>>> html = open(join(docs, 'build', 'html', 'index.html')).read()
>>> 'plone_logo.png' in html


Tarek Ziadé, Author

Change history

0.1.1 (2008-09-11)

  • Using a sphinx-build local to the environment [Tarek]

0.1.0 (2008-09-10)

  • Initial implementation [Tarek Ziadé]
  • Created recipe with ZopeSkel [Tarek Ziadé].
File Type Py Version Uploaded on Size
collective.recipe.sphinxbuilder-0.1.1.tar.gz (md5) Source 2008-09-11 20KB