提供文档¶
动物园文档是由动物园开发人员管理的协作过程。欢迎任何人参与动物园项目文件。在进行此操作之前,请考虑以下说明。
一般信息¶
航向语法¶
tere是文档中使用的各种标题标题,创建新文档时,请遵循以下标题下划线语法:
对于标题1,使用
=
,对于标题2,使用
-
,对于标题3,使用
.
,对于标题4,使用
*
,对于标题5,使用
#
.
对于新来者¶
鼓励新用户使用以下方式提交文档:
下载动物园项目SVN,编辑位于/docs目录的文档文件,并通过设置为“文档”跟踪器的新票据共享修改。
创建一个包含新的或更正的文档文本的wiki页面,并创建一个新的通知单来报告其创建情况。
负责这些文件的动物园开发商将审查这些贡献,将它们添加到官方文件中。
对于注册开发商¶
动物园项目文档流程的当前结构是为 SVN 提交访问权限以将其文档维护为restructuredtext格式,因此所有文档都位于SVN的/docs目录中。这个 Sphinx 文档生成器用于将RestructedText文件转换为HTML,然后每小时更新一次Live网站。
安装和使用Shpinx¶
在Linux上¶
确保安装了python dev和setuptools包。例如,在Ubuntu上:
sudo apt-get install python-dev sudo apt-get install python-setuptools
使用“轻松安装”安装Sphinx:
sudo easy_install Sphinx==1.3.1
备注
确保安装的是Sphinx 1.3.1或更高版本。
从svn签出/docs目录,例如:
svn checkout http://svn.zoo-project.org/svn/trunk zoo-project
要处理文档,请从zoo/docs目录运行:
make html
或
make latex
HTML输出将写入build/html子目录。
备注
如果有多个翻译,上述命令将自动生成所有翻译。
在Mac OS X上 ™¶
使用“轻松安装”安装Sphinx:
sudo easy_install-2.7 Sphinx==1.3.1
备注
确保安装的是Sphinx 1.3.1或更高版本。
安装 MacTex 如果您想构建PDF
从svn签出/docs目录,例如:
svn checkout http://svn.zoo-project.org/svn/trunk zoo-project
要处理文档,请从zoo/docs目录运行:
make html
或
make latex
HTML输出将写入build/html子目录。
在Windows上 ™¶
安装 Python 2.X
下载 setuptools
确保
C:/Python2X/Scripts
目录是您的路径在命令行执行以下操作:
easy_install Sphinx==1.3.1
…您应该看到消息:“已完成处理Sphinx的依赖项”
备注
确保安装的是Sphinx 1.3.1或更高版本。见上文注释。
安装 MiKTeX 如果您想构建PDF
从svn签出/docs目录,例如:
svn checkout http://svn.zoo-project.org/svn/trunk zoo-project
在/docs目录中,执行:
make html
或
make latex
HTML输出将写入u build/html子目录。
重构文本参考指南¶
以下资源被认为对编辑和创建新的动物园项目文档文件很有用。
文档实用程序 Quick reStructuredText
文档实用程序 reStructuredText Directives
Shpinx reStructuredText Primer
搜索Sphinx的 mailing list