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 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:
[buildout]
parts = sphinx
anaconda-home = /home/myself/anaconda
[sphinx]
recipe = birdhousebuilder.recipe.sphinx
project = Emu
version = 0.2
src = emuCarsten Ehbrecht <ehbrecht@dkrz.de>
Changes
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 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
File details
Details for the file birdhousebuilder.recipe.sphinx-0.1.5.tar.gz.
File metadata
- Download URL: birdhousebuilder.recipe.sphinx-0.1.5.tar.gz
- Upload date:
- Size: 15.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2ecb924fe261df4dad11065ca69c3c9f4b6ece97b6acb1eaa333ac1ab1e78110 |
|
| MD5 | 29672a87b4d5cbe987dedd0b043680f7 |
|
| BLAKE2b-256 | 14e96d0c2386b35d7d5115f0c19eb723d1690f641b0e2f312911215b3539066b |
