Ross Wan's World!

Python, Ajax, PHP and Linux.

好用的文档工具:reStructuredText

Posted by Ross Wan 于 2008/09/09

对于文档,最困难的就是排版,以及规范的格式。而 reStructuredText 就可以解决这个问题。它可以将纯文本重构建成格式规范的文档,输出成 html、xml、Latex 或者 PDF。妳只需要简单学习一下 reStructedText 的语法标记来编写那个纯文本即可。

reStructuredText 的学习曲线一点也不高,它跟 Python 的语法有点相近,主要通过缩进来定义元素。具体可以看看官网的文档:

中文文档可以参考《reStructuredText 简明教程》,由 Laurence 编写,Kardinal 翻译过来的:

编写好的源文档,需要使用一个 Python 工具 docutils 将其转化成 Html 或者 Latex 等等:(以在 Archlinux 系统下生成 Html 文件为例)

# pacman -Ss docutils

$ rst2html.py source.rst dest.html

这样就可以将 source.rst 纯文本文件转化成 HTML 格式的 dest.html 文档。

Advertisements

发表评论

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / 更改 )

Twitter picture

You are commenting using your Twitter account. Log Out / 更改 )

Facebook photo

You are commenting using your Facebook account. Log Out / 更改 )

Google+ photo

You are commenting using your Google+ account. Log Out / 更改 )

Connecting to %s

 
%d 博主赞过: