为Birdhouse生成基于Sphinx的文档的Buildout配方。
项目描述
简介
为Birdhouse组件设置Sphinx文档的Buildout配方。
该配方基于https://pypi.python.org/pypi/collective.recipe.sphinxbuilder
用法
该配方需要已安装Anaconda。您可以使用buildout选项anaconda-home来设置Anaconda安装的前缀。否则，使用环境变量CONDA_PREFIX（变量在激活conda环境时设置）作为conda前缀。
该配方在docs中为Sphinx构建一个初始文档文件夹。该配方配置sphinx-autoapi从源代码生成API参考文档。
该配方依赖于birdhousebuilder.recipe.conda和zc.recipe.egg
支持选项
该配方支持以下选项
- project (默认：MyBird)
指定项目名称。
- author (默认：Birdhouse)
指定项目的作者。
- version (默认：0.1)
指定项目的版本。
- use_autoapi (默认：true)
设置为fals如果您不希望使用sphinx-autoapi。
- src (默认：.)
指定供sphinx-autoapi使用的源文件夹的路径。
示例用法
设置项目Emu的文档
[buildout]
parts = sphinx
[sphinx]
recipe = birdhousebuilder.recipe.sphinx
project = Emu
version = 0.2
src = emuCarsten Ehbrecht <ehbrecht@dkrz.de>
变更
0.2.4 (2018-01-17)
pep8。
使用alabaster主题。
使用pywps autodoc扩展。
0.2.3 (2016-07-25)
将鸟屋添加到intersphinx。
0.2.2 (2016-07-15)
修复twitcher链接。
0.2.1 (2016-07-11)
更新到最新conda配方。
更新测试套件。
0.2.0 (2016-07-01)
将conda.makedirs替换为os.makedirs。
0.1.7 (2016-06-02)
修复readthedocs网址。
0.1.6 (2016-06-01)
添加rst_epilog链接。
忽略localhost链接。
添加linkcheck_timeout。
0.1.5 (2016-02-19)
添加use_autoapi选项。
0.1.4 (2016-02-19)
添加linkcheck选项。
0.1.3 (2015-10-24)
为readthedocs设置requirements/rtd.txt。
0.1.2 (2015-10-24)
将autodoc替换为sphinx-autoapi扩展。
为sphinx-autoapi使用src选项。
0.1.1 (2015-10-23)
添加extra_paths。
在conf.py模板中添加sys.path。
0.1.0 (2015-10-23)
初始版本
birdhousebuilder.recipe.sphinx-0.2.4.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 57017eddb2be2832b310a8dadea2581bfb579465514e949e66498258ddac7b3e |
|
| MD5 | 697b1147b6a1a9e1c24e510efc08aceb |
|
| BLAKE2b-256 | dbc12b4c97a90d421bf78ad2d8789bb7d4d57da2f8142084e219896734a5bc1a |
