birdhousebuilder.recipe.sphinx
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. 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:
[buildout]
parts = sphinx
[sphinx]
recipe = birdhousebuilder.recipe.sphinx
project = Emu
version = 0.2
src = emu
Carsten Ehbrecht <ehbrecht@dkrz.de>
Changes
0.2.4 (2018-01-17)
pep8.
using alabaster theme.
using pywps autodoc extension.
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 conf.py template
0.1.0 (2015-10-23)
Initial Release
Metadata
Release files for birdhousebuilder.recipe.sphinx 0.2.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| birdhousebuilder.recipe.sphinx-0.2.4.tar.gz | 17.2 kB | Without provenance | Details for birdhousebuilder.recipe.sphinx-0.2.4.tar.gz |
Release files / birdhousebuilder.recipe.sphinx-0.2.4.tar.gz
| Download URL | birdhousebuilder.recipe.sphinx-0.2.4.tar.gz |
|---|---|
| Size | 17.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
57017eddb2be2832b310a8dadea2581bfb579465514e949e66498258ddac7b3e
|
|
BLAKE2b-256 checksum How to use checksums |
dbc12b4c97a90d421bf78ad2d8789bb7d4d57da2f8142084e219896734a5bc1a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for birdhousebuilder.recipe.sphinx 0.2.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.