Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

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

Project Description


Buildout Recipe to setup Sphinx Documentation for Birdhouse Components.

The recipe is based on


The recipe requires that Anaconda is already installed. You can use the buildout option anaconda-home to set the prefix for the anaconda installation. Otherwise the environment variable CONDA_PREFIX (variable is set when activating a conda environment) is used as conda prefix.

The recipe builds an initial docs folder for Sphinx in docs. The recipe configures sphinx-autoapi 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.
use_autoapi (default: true)
Set to fals if you don’t want to use the sphinx-autoapi.
src (default: .)
Specify path to source folder which will be used by sphinx-autoapi.

Example Usage

Set up the docs for the project Emu:

parts = sphinx

recipe = birdhousebuilder.recipe.sphinx
project = Emu
version = 0.2
src = emu

Carsten Ehbrecht <>


0.2.3 (2016-07-25)

  • added birdhouse to intersphinx.

0.2.2 (2016-07-15)

  • fixed twitcher link.

0.2.1 (2016-07-11)

  • updated to latest conda recipe.
  • updated test suite.

0.2.0 (2016-07-01)

  • replaced conda.makedirs by os.makedirs.

0.1.7 (2016-06-02)

  • fixed readthedocs urls.

0.1.6 (2016-06-01)

  • rst_epilog links added.
  • ignore localhost links.
  • linkcheck_timeout added.

0.1.5 (2016-02-19)

  • added use_autoapi option.

0.1.4 (2016-02-19)

  • added linkcheck options.

0.1.3 (2015-10-24)

  • setups requirements/rtd.txt for readthedocs.

0.1.2 (2015-10-24)

  • replaced autodoc by sphinx-autoapi extension
  • using src option for sphinx-autoapi

0.1.1 (2015-10-23)

  • added extra_paths
  • added sys.path in template

0.1.0 (2015-10-23)

Initial Release

Release History

Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
birdhousebuilder.recipe.sphinx-0.2.3.tar.gz (16.3 kB) Copy SHA256 Checksum SHA256 Source Jul 25, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting