Docutils 项目文档概述

Author:eonwen
Contact:eonwen@hotmail.com

最新的工作文档可以独立访问以下链接或查看 Docutils分发 的 doc 文件夹.

Docutils相关

Docutils相关可以以几种方式归类:

  1. 终端用户: reStructuredText和Docutils工具的用户。 尽管有一些是开发者(如Python开发者为其源文件中的 文档字符串利用reStructuredText)，但许多不是。
  2. 客户端开发者: 开发者使用Docutils作为一个库，编程人员 使用 Docutils进行开发。
  3. 组件开发者: 那些实现与Docutils分离的指定应用程序组件、指令 和/或角色的人。
  4. 核心开发者: Docutils基代码的开发者和Docutils项目社区的参与者。
  5. 重实现者: Docutils的替代实现的开发者。

这些组中有许多重叠的部分。大部分(也许是全部)核心开发者、组件开发者、客户端开发者和重实现者也是终端用户。核心开发者也是客户端开发者，同时还可能是其他项目的组件开发者。组件开发者也是客户端开发者。

项目基本原则

这些文件是Docutils全部相关内容。它们被保存在Docutils项目的顶级文件夹。

README.txt:项目概述: 快速开始、需求、安装和用法。
COPYING.txt:Docutils重新分发的条件，包含证书的链接。
FAQ.txt:Docutils常见问题。如果你有问题或争论，有很大可能已经在这里回答了。
BUGS.txt:已知问题的列表及如何报告一个bug。
RELEASE-NOTES.txt:
 最近版本的主要修改的摘要。
HISTORY.txt:Detailed的更新记录。
THANKS.txt:致谢。

ref/: 针对所有组的参考材料

这些材料中许多最初是作为开发者规范的，但现在它们已经成熟并由终端用户和客户端开发者使用，它们已经成为了参考材料。成功的由规范变为了参考材料。

Docutils通用:

尽管不再”ref”文件夹中， PEP 258 对于任何Docutils开发者来说都是一个必读参考。

reStructuredText:

史前:

peps/: Python增强建议

请注意， 主仓库 中的PEPs可能不是最新版本，反之其为本地版本。