--
http://zoomquiet.org
'''过程改进乃是催生可促生靠谱的人的组织!'''
Free as in Freedom! 哲思自由软件社区:http://zeuux.org
2008/12/17 Jiahua Huang <jhuang...@gmail.com>:
--
http://zoomquiet.org
'''过程改进乃是催生可促生靠谱的人的组织!'''
多吃菜,少喝酒;听老婆的话,跟党走!
我贴过的 rst2pdf.py 就是 ReST 直接生成 PDF
贴下出错信息,
或可否贴下你的 rst 文件
有没有sphinx教程之类的东西啊。
--
I like python!
UliPad <<The Python Editor>>: http://code.google.com/p/ulipad/
UliWeb <<simple web framework>>: http://uliwebproject.appspot.com
My Blog: (new)http://http://hi.baidu.com/limodou
(old)http://www.donews.net/limodou
sphinx 是一个用python写的,可以根据restructtxt 构建文档的工具。可以把一系列的 reStructuredText文件转换为其他格式,而且可以自动生成交叉参照,索引等。
python 2.4 以上 pygments (可选),docutils0.4 以上
文档源目录(包含reStructuredText文件的最上层目录),通常情况下,这个目录也包 含一个叫conf.py的文件。当然,在新版本中(0.3以上),这个文件也可以放在"配置 目录"(configration directory)。运行 sphinx-quickstart 可以产生 源文档目录, 里面有conf.py
示例 >sphinx-build -b latex sourcedir builddir
sourcedir 就是文档源文件夹,builddir是build的输出目录。-b选项选择一个builder。示 例中将构建 latex 文件。
一些选项的介绍:
这个重新生成所有文件,默认只是生成新的,或者改变过的文件。
不用先前生成的environment,全部重新build。上一次构建时间为A, 默认情况下,只 是构建A后新加的、或者修改过的。
sphinx首先读入源文件,分析并产生一些中间文件(doctree pickles)。通常这些文件放 在builddir/.doctrees 下,-d 这个选项,可以改变这个缓存目录。
不要在sourcedir下寻找conf.py, 而是在-c 制定的配置目录path中寻找,注意,那些 在conf.py 中定义的文件,目录等配置值(configuration values)都是相对配置目录的。 因此那些文件,目录也要放置到对应的位置。
覆盖conf.py中的配置值,(这个值必须是一个字符串)
不带色彩输出。(windows 上不能带色输出,悲哀)
除了warnning和error ,什么也不输出
reST源文件可以有不同的扩展名,(比如.txt,.rst 。扩展名可以用 source_suffix配置) 不同的操作系统有不同的路径分隔符,Sphinx 从源文档文件夹中抽取符合扩展名的文件。 并去掉扩展名,路径分隔符转换为斜杠(slashes)。文档中的交叉参照也是依据这个路径
reST不支持多个文档连接,或者把一个文档输出多个文件。Sphinx自定义了指令,用于表示 组成文档的多个文件间的关系。 其中文档树 toctree指令是核心元素
这条指令(..toctree::)在文档当前位置插入一个目录 "TOC tree",他包括几个独立的 子目录(TOCs)。maxdepth选项用于表示树的深度,默认情况下。包括所有层。
比如
.. toctree::
:maxdepth: 2
intro
strings
datatypes
numeric
(many more documents listed here)
以上代码实现了两个功能:
- 子项intro等的目录被插入到文档这个地方,其深度为2. (这个表述不清,实际使用 一下,就明白了。)
- Sphinxt通过子目录描述知道了intro,strings 等的顺序,并且知道这些是当前文档 的子文档。通过这些信息,它产生next chapter,previous chpter,和 parent chapter 连接。
目录的标题是从它链接的文档中读出,可以通过特定格式修改。比如:
.. toctree::
intro
All about strings <strings>
datatypes
All about strings 就是新的标题。
目录指令集中可以用glob标志,制定搜索"globbing"功能,匹配选项会被插入 示例:
.. toctree::
:glob:
intro*
recipe/*
*
这个目录将包括以intro开始的文档,以及recipe下面的文档,以及所有的剩余的文档。 (当然,除了包含这个目录树的文件)
另外,所有文档,都必须出现在目录树的某处,否则sphinx会显示一个警告,因为这意味着 这个该文档不能页面导航到达, 使用unused_documents 表示那些文档不build。 exclude_dirs 表示那些目录不构建。
主控文档通过 master_doc 标示,它的目录将是根目录,可以被用于文档的主页。如果 maxdepth选项没有设置,它将显现所有内容的目录。
你这个就是它的文档的简化版。我想知道如何从开始一步步地去生成sphinx。我看文档中需要一个sphinx-quickstart的处理,这个是必须的吗?生成哪些东西就可以测试了,有没有一个象hello,world的示例?
问下,邮件前面[CPyUG:73918]
是怎么加上去的,文档我发到邮件列表了。可好像我发的邮件,都没有CPyUG