collective.recipe.sphinxbuilder 0.2

.. contents::

- Code repository: https://svn.plone.org/svn/collective/buildout/collective.recipe.sphinxbuilder/
- Questions and comments to tarek_at_ziade.org


Detailed Documentation
**********************

What is Sphinx ?
================

Sphinx is the rising tool in the Python community to build
documentation. See http://sphinx.pocoo.org.

It is now used for instance by Python. See http://docs.python.org/dev and many
others

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::

[buildout]
parts =
...
sphinxbuilder
...

[sphinxbuilder]
recipe = collective.recipe.sphinxbuilder


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

- a new script in the `bin` folder, called `sphinxbuilder`
- a `parts/sphinxbuilder` directory containing your documentation.

To build your documentation, just run the sphinx script::

$ bin/sphinxbuilder

You will get a shiny Sphinx documenation in `docs/html`.
To write your documentation, go in `docs/source`, if there is none create it.
Everytime source is modified, run the buildout and script again.

A good starting point to write your documentation is:
http://sphinx.pocoo.org/contents.html.

Providing documentation from packages
=====================================

You can also include documentation from packages by providing entry_point.
Entry points will be picked by order you provide in eggs buildout option.::

setup(
...
entry_points = dict('collective.recipe.sphinxbuilder':
'default: custom.package.docs')
...
)

With this entry point declaration above we declared that there is a 'docs'
module in 'custom.package' which can contain:
- conf.py
Default values for sphinx. You can still override them with
buildout configuration.
- static directory
Override default static file/s.
- template directory
Override default template file/s.
- source files
Root of our entry point module will be searched for any source files,
depending on what suffix you choose.

Supported options
=================

The recipe supports the following options:

docs-directory
Specify the build documentation root. Default to `docs`.

outputs
Multiple-line value that defines what kind of output to produce.
Can be `html`, `latex` or `pdf`. Defaults to `html`.

script-name
The name of the script generated. Defaults to the name of the section.

project
The name of the project used in Plone. Defaults to Plone.

extensions
Sphinx extensions in use. Defaults to none.

master
Name of the index file. Defaults to `index`.

year
Year of the project. Defaults to current year.

suffix
File extensions used for reST file. Defaults to .txt

author
Author. Defaults to Plone Community.

version
Version. Defaults to 1.0.

release
Release. Defaults to 1.0.

dot
The prefix of the static and template directory.
Defaults to '.' under Linux and '_' under Windows.

logo
Logo used for html and pdf. Defaults to plone.png
(which is provided by the recipe)

css
css file used to change Sphinx look. Defaults to
plone.css (which is provided by the recipe)

latex_options
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 = sphinxbuilder
...
... [sphinxbuilder]
... recipe = collective.recipe.sphinxbuilder
... """)

Let's run the buildout::

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

What are we expecting ?

A `docs` folder with a Sphinx structure::

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

>>> source = join(sample_buildout, 'parts', 'sphinxbuilder')
>>> ls(source)
d .static
d .templates
- conf.py
- 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-build
- sphinxbuilder

The content of the script is a simple shell script::

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

>>> print 'start', system(script)
start mkdir -p /sample-buildout/docs/html /sample-buildout/docs/doctrees
...

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

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

Let's see our script now::

>>> cat(script)
cd ...docs
make html
make latex
make latex && cd ... && make

Finally let's run it::

>>> print 'start', system(script)
start mkdir -p /sample-buildout/docs/html /sample-buildout/docs/doctrees
...
Transcript written in modPlone.ilg.
<BLANKLINE>

We should have some nice reST file::

>>> print open(join(sample_buildout, 'parts', 'sphinxbuilder', 'index.txt')).read()
.. Plone documentation master file, ...
<BLANKLINE>
Welcome to Plone's documentation!
=================================
<BLANKLINE>
Contents:
<BLANKLINE>
.. toctree::
:maxdepth: 2
<BLANKLINE>
Indices and tables
==================
<BLANKLINE>
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
<BLANKLINE>
<BLANKLINE>

And the html rendering should use the plone logo::

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



Contributors
************

Tarek Ziade, Author
Rok Garbas, likes mandarines


Change history
**************

0.2.0 (2008-11-11)
==================

- source tree generated every time under parts/<buildout-section-name> [Rok Garbas]
- finds conf options, source, static and template files using entry_point
'collective.recipe.sphinxbuilder' [Rok Garbas]
- custom source folder at docs/source [Rok Garbas]
- build section moved to docs/html, docs/latex [Rok Garbas]

0.1.1 (2008-09-11)
==================

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

0.1.0 (2008-09-10)
==================

- Initial implementation [Tarek Ziade]
- Created recipe with ZopeSkel [Tarek Ziade].


Download
********