birdhousebuilder.recipe.sphinx 0.1.0

Buildout recipe to generate and Sphinx-based documentation for Birdhouse.

Contents

• Introduction

• Usage

  • Supported Options

  • Example Usage

• Changes

Introduction

Buildout Recipe to setup Sphinx Documentation for Birdhouse Components.

The recipe is based on https://pypi.python.org/pypi/collective.recipe.sphinxbuilder

Usage

The recipe requires that Anaconda is already installed. It assumes that the default Anaconda location is in your home directory ~/anaconda. Otherwise you need to set the ANACONDA_HOME environment variable or the Buildout option anaconda-home.

The recipe builds an initial docs folder for Sphinx in docs. The recipe runs sphinx-apidocs to generate the api reference documetation from the source code.

The recipe depends on birdhousebuilder.recipe.conda and zc.recipe.egg

Supported Options

The recipe supports the following options:

project (default: MyBird)

Specify the project name.

author (default: Birdhouse)

Specify the author of the project.

version (default: 0.1)

Specify the version of the project

Example Usage

Set up the docs for the project Emu:

[buildout]
parts = sphinx

anaconda-home = /home/myself/anaconda

[sphinx]
recipe = birdhousebuilder.recipe.sphinx
project = Emu
version = 0.2

Carsten Ehbrecht <[e-mail]>

Changes

0.1.0 (2015-10-23)

Initial Release