OnlyPython - What’s New in Python 2.6 翻译 (二) ...

来源：百度文库 编辑：神马文学网 时间：2024/04/29 07:37:36

新的文档格式：使用reStructuredText的Sphinx

Python项目从1989年左右开始以来，文档的写作一直是使用LaTex。在80年代和90年代初，大多数的文档都是被打印出来进行学习，而不是在线进行阅读。LaTex被大范围的使用是因为它不仅提供了非常吸引人的打印效果，而且标记规则学习起来也非常简单直接。

现在，LaTex仍然被用于写作需要出版的作品，但是在编程工具领域，情况以及发生改变。我们不再打印大量的文档，相反，我们开始在线阅读，并且 HTML已经成为了需要支持的最重要的一种格式。遗憾的是，从LaTex转换到HTML比较复杂，而且Fred L. Drake Jr.，长期的Python文档编辑，已经花费了大量的时间来维护文档转换的流程。不时会有人建议将文档转换成SGML以及后来的XML格式，但是始终没有人能够拿出足够的时间来完成主要的转换工作。

在2.6的开发周期中，Georg Brandl花费了大量的精力，为文档处理创建了一个新的工具链(toolchain)，就是Sphinx，在http://sphinx.pocoo.org/可以找到。

Sphinx致力于HTML输出，产生有吸引力，时髦的HTML；打印输出仍然可以通过转换成LaTex来搞定。文档的输入格式是reStructuredText，一种支持自定义扩展和指令，在Python社区经常被使用的标记语言。

Sphinx是一个可以用于写作的独立的package，已经有将近20多个其他的项目（参见Sphinx的网站 ）已经将Sphinx作为他们的文档工具。

参考：

Documenting Python 描述了怎样进行Python文档的写作

Sphinx Sphinx的文档和代码.

Docutils 底层的reStructuredText解析器和工具集



相关文章：
准备开始翻译What’s New in Python 2.6
What’s New in Python 2.6 翻译 (一) 
OnlyPython - What’s New in Python 2.6 翻译 (二) ... What‘s New in Java SE 6 Beta 2 What’s new in Diffusion Toolkit 0.6 – track What's in that drink? The Pulitzer Prizes | What's New What's in an HTTP request? Zero death--What's behind New Zealand quake miracle? What's in Dalai Lama's mind on his birthday? What‘s in the Journals, November 2006 | Econo... JSR-170: What's in it for me? -- CMS Watch Beijing Invokes FDR‘s New Deal - Newsweek: In... beautiful Soup in Python 技术论坛 : 一周最新技术产品 Best of What‘s New 060831 ... Open question: boundedness of the trilinear Hilbert transform « What’s new Methods GET and POST in HTML forms - what‘s the difference? Methods GET and POST in HTML forms - what‘s the difference? ArcGIS 9.3新特性之ArcGIS Engine（What's Coming in ... Buffett‘s Gift: Starting a New Page in the History of Giving to Charity The New Myth in China: China’s Rising Middle-class will accelerate democratization What's the joke? What's FDF? WHAT'S LOVE? What's naked truth ? What's love?