Python文档工具快速上手指南
Posted on Wed 18 August 2010 in 我用(IT)
本文档的pdf版本下载地址。
============================== Python文档工具快速上手指南 ==============================
:Auther: LiYan :Version: 1.0.0 :Date: 2010-08-18
.. contents::
Reference
背景知识
首先介绍一下reStructuredText和DocUtils。前者是一套纯文本标记语法, 后者是Python基于reStructuredText(简称ReST)文档工具。
ReST提供了一种简洁明了的文档语言,用户用这种语言写出文档, 再用DocUtils所提供的一些脚本将其转换成HTML(rst2html.py)、 Latex(rst2latex.py)、S5(rst2s5.py)等等格式。
然后rst2pdf隆重出场,利用这个工具可以把ReST格式的文本方便的转成pdf。
相关链接
Python_:
.. _Python: http://www.python.org/
来自google code的 rst2pdf_:
.. _rst2pdf: http://code.google.com/p/rst2pdf/
ReST使用指南 QuickRef_:
.. _QuickRef: http://docutils.sourceforge.net/docs/user/rst/quickref.html
在Windows环境下安装rst2pdf
:前提条件: 我用的是Windows XP,安装的是Python2.6
easy_install rst2pdf
一个注意事项
需要把python下面的scripts目录加到路径中
下面是我的环境变量:: path=C:Python26;C:Python26Scripts;%path%
Usage Guide
Base Usage
rst2pdf readme.txt
打开pdf,中文都是黑点儿。
对中文的支持
编辑如下文件::
{ "embeddedFonts" : [ ["simfang.ttf","simhei.ttf","simkai.ttf","simsun.ttc"]], "fontsAlias": { "stdFont": "simfang", "stdBold": "simhei", "stdItalic": "simkai", "stdMono": "simkai" } }
命名为chinese.style
再次执行命令:: rst2pdf readme.txt -s chinese.style
中文正常显示了。