为鸟舍生成和基于斯芬克斯的文档。

birdhousebuilder.recipe.sphinx的Python项目详细描述


Travis Build

简介

构建为Birdhouse组件设置Sphinx文档的方法。在

配方是基于https://pypi.python.org/pypi/collective.recipe.sphinxbuilder

使用

配方要求已安装Anaconda。您可以使用buildout选项anaconda-home为anaconda安装设置前缀。否则,环境变量CONDA_PREFIX(变量在激活conda环境时设置)用作conda前缀。在

配方在docs中为Sphinx构建一个初始docs文件夹。 配方配置sphinx autoapi从源代码生成api引用文档。在

配方取决于birdhousebuilder.recipe.condazc.recipe.egg

支持的选项

配方支持以下选项:

project(默认:MyBird
指定项目名称。
author(默认:Birdhouse
指定项目的作者。
version(默认:0.1
指定项目的版本。
use\u autoapi(默认:true
如果您不想使用sphinx autoapi,请将
设置为fals
src(默认:
指定sphinx autoapi将使用的源文件夹的路径

示例用法

为Emu项目建立文档:

[buildout]parts=sphinx[sphinx]recipe=birdhousebuilder.recipe.sphinxproject=Emuversion=0.2src=emu

卡斯滕·埃布雷希特<;ehbrecht@dkrz.de>

变更

0.2.4(2018-01-17)

  • pep8。在
  • 使用雪花石膏主题。在
  • 使用pywps autodoc扩展。在

0.2.3(2016-07-25)

  • 为Interspinx增加了鸟舍。在

0.2.2(2016-07-15)

  • 固定连杆。在

0.2.1(2016-07-11)

  • 更新至最新康达配方。在
  • 更新的测试套件。在

0.2.0(2016-07-01)

  • 替换康达·马克迪尔斯通过操作系统makedirs. 在

0.1.7(2016-06-02)

  • 修复了readthedocs的url。在

0.1.6(2016-06-01)

  • 添加了rst_epilog链接。在
  • 忽略本地主机链接。在
  • linkcheck_超时已添加。在

0.1.5(2016-02-19)

  • 添加了use_autoapi选项。在

0.1.4(2016-02-19)

  • 添加了链接检查选项。在

0.1.3(2015-10-24)

  • 设置要求/电阻式温度检测器.txt读道。在

0.1.2(2015-10-24)

  • 将autodoc替换为sphinx autoapi扩展
  • 对sphinx autoapi使用src选项

0.1.1(2015-10-23)

  • 添加了额外的路径
  • 已添加系统路径在配置文件模板

0.1.0(2015-10-23)

初次发行

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
用户界面最佳所见即所得Java UI编辑器   java*servlet。xml与applicationContext。xml   java Android SDK在发布时挂起设备   java如何异步处理GAE数据存储争用?   java如何在redis中为SSO刷新令牌的过期时间?   java从全文搜索中删除索引   java CXFServlet初始启动   java在使用mavenspringbootplugin时向SpringBoot命令行start添加类路径   java工厂模式是正确的模式吗?   java-JVM信号链SIGPIPE   java JavaFx savely正在停止后台任务   整数Java打印数字的小数点   java如何连接到用户选择的SSID?   java组织。h2。jdbc。JdbcSQLException:列计数不匹配   java文件。toURI不编码加号