Skip to main content

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

Project description

Travis Build


Buildout Recipe to setup Sphinx Documentation for Birdhouse Components.

The recipe is based on


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

anaconda-home = /home/myself/anaconda

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

Carsten Ehbrecht <>


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

Project details

Download files

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

Files for birdhousebuilder.recipe.sphinx, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size birdhousebuilder.recipe.sphinx-0.2.0.tar.gz (15.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page