项目文档概述¶
- Author
David Goodger
- Contact
- Date
$Date: 2016-01-13 22:09:13 +0100 (Mi, 13. J盲n 2016) $
- Revision
$Revision: 7933 $
- Copyright
本文档已置于公共领域。
最新的工作文档可以在下面单独访问，也可以从 Docutils distribution 的 docs 目录中访问。
目录
Docutils 利益相关者¶
Docutils利益相关者可以分为几组:
最终用户: reStructuredText和Docutils工具的用户。虽然有些是开发人员（例如Python开发人员在其源代码中使用reStructuredText作为文档字符串），但许多人不是。
客户端开发人员: 使用Docutils作为库的开发人员，使用 Docutils开发 的程序员。
组件开发人员: 与Docutils分开实现特定于应用程序的组件，指令和/或角色的人员。
核心开发人员: Docutils代码库的开发人员和Docutils项目社区的参与者。
重新实施者: Docutils的替代实施的开发者。
这些群体之间存在很多重叠。大多数（可能是所有）核心开发人员，组件开发人员，客户端开发人员和重新实现者也是最终用户。核心开发人员也是客户端开发人员，也可能是其他项目的组件开发人员。组件开发人员也是客户端开发人员。
项目基础¶
这些文件适用于所有Docutils利益相关者。它们保存在Docutils项目目录的顶层。
- README.txt
项目概述: 快速入门，要求，安装和使用。
- COPYING.txt
Docutils重新分发的条件，包含许可证的链接。
- FAQ.txt
Docutils常见问题解答。如果您有疑问或问题，很有可能它已经在这里得到解答。
- BUGS.txt
已知错误的列表，以及如何报告错误。
- RELEASE-NOTES.txt
已知错误列表以及如何报告错误。
- HISTORY.txt
详细的更改历史日志。
- THANKS.txt
致谢.
user/: 最终用户的入门和教程材料¶
Docutils-通用:
编辑器特有:
快速 reStructuredText (用户参考)
reStructuredText 备忘单 (纯文本; 1页语法，1页指令和角色参考)
reStructuredText 示范 (大多数reStructuredText功能的演示; 您还可以查看 文本源)
编辑支持:
ref/: 所有组的参考资料¶
其中许多文件都是作为开发人员规范开始的，但现在它们已经成熟并被最终用户和客户端开发人员使用，它们已成为参考资料。成功的规范演变为refs。
Docutils-通用:
Docutils文档树 (incomplete)
OASIS XML交换表模型声明模块 (CALS tables DTD module)
虽然不在 “ref” 目录中，但是 ‘PEP 258`_ 是任何Docutils开发人员必读的参考文献。
An Introduction to reStructuredText (includes the Goals and History of reStructuredText)
史前:
peps/: Python增强建议¶
PEP 256: Docstring Processing System Framework is a high-level generic proposal. [PEP 256 in the master repository]
PEP 257: Docstring Conventions addresses docstring style and touches on content. [PEP 257 in the master repository]
PEP 258: Docutils Design Specification is an overview of the architecture of Docutils. It documents design issues and implementation details. [PEP 258 in the master repository]
PEP 287: reStructuredText Docstring Format proposes a standard markup syntax. [PEP 287 in the master repository]
请注意， master repository 中的PEP可能不是最新的，而本地版本是。
api/: 客户端开发人员的API参考资料¶
PEP 258 是Docutils架构的概述.