Buildout recipe to generate and Sphinx-based documentation for Birdhouse.
Project description
Introduction
Buildout Recipe to setup Sphinx Documentation for Birdhouse Components.
The recipe is based on https://pypi-hypernode.com/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.2Carsten Ehbrecht <ehbrecht@dkrz.de>
Changes
0.1.1 (2015-10-23)
added extra_paths
added sys.path in conf.py template
0.1.0 (2015-10-23)
Initial Release
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for birdhousebuilder.recipe.sphinx-0.1.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 666999065458b9b402f55b631f36774c53153ad48484597418bc1b5a870a5be6 |
|
| MD5 | 0044911be054e22d360a8938bf685d2a |
|
| BLAKE2b-256 | a90cc57192627b6e1b4a698927eac479f8b4cb80c0aeda357349fcaa68c6c9a9 |
