Python文档工具快速上手指南 | 李三火

Python文档工具快速上手指南

发表于 2010/08/18 由 twotwo

本文档的pdf版本下载地址。

==============================
Python文档工具快速上手指南
==============================

:Auther: LiYan
:Version: 1.0.0

ate: 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:\Python26\Scripts;%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

中文正常显示了。

相关日志

• 无相关日志

此条目发表在 我用(IT) 分类目录，贴了 DocUtils, reStructuredText, rst2pdf 标签。将固定链接加入收藏夹。

← 盖洛普Q12的学习笔记

对学生时代评语的解读 →

《Python文档工具快速上手指南》有 2 条评论

1. 

   Roberto Alsina 说：

   2010/08/2703:44

   I’m very happy to see rst2pdf was useful for you!

   Are those chinese fonts free or widely available? If that’s the case, I would like to add this chinese stylesheet to rst2pdf so it’s easier for chinese users.

   Could you contact me to see if we can make this work? My email is in the README

   
2. 

   twotwo 说：

   2010/08/2718:44

   No, these fonts only available in m$’s os.
   You can find licence info at http://www.ascenderfonts.com/font/simsun-simplified-chinese.aspx