Docutils:文档实用工具¶
用 Python 编写,用于通用和特殊用途¶
Docutils(全称 Documentation Utilities)是一个开源文本处理系统,用于将纯文本文档处理成有用的格式,如 HTML、LaTeX、man-pages、OpenDocument 或 XML。它包括 reStructuredText ,这是一种易于阅读、易于使用、所见即所得的纯文本标记语言。
概述¶
要快速启动和运行,请参阅 README 文件的 快速上手 部分。运行 Docutils 的唯一 需求 是 Python 。
所有文档都可以从 Project Documentation Overview 中获取。如果有什么不清楚或缺失的地方,可以向 docutils-users 邮件列表询问。
项目页面 有到跟踪器、邮件列表和代码存储库的链接。
所有关于 Docutils 的讨论都发生在 mailing lists 中。
对于开源项目的开发人员来说,反馈 是一个很好的激励因素,非常受欢迎。我们还依赖反馈来决定要实现哪些特性。因此,如果你告诉我们你需要什么,我们可能会帮助你!请将任何反馈信息发送到 docutils-users 邮件列表。
如果发现错误,请 提交错误报告 或通过邮件发送到 docutils-users。
我们欢迎各种各样的贡献。有一个 待办清单,上面满是等待冠军的想法。如果您有任何关于如何扩展 Docutils 的问题,请随时在 docutils-develop 邮件列表上提问。补丁提交应归档到 补丁追踪器 (首选)或发送到 docutils-develop 。
下载¶
发布包 可以从 PyPI 下载。它们主要是为发布准备的。请参阅 发布说明,了解自上一版本以来的变化。
我们建议您使用 Docutils Subversion 仓库 中的 snapshot 1。与“官方”—版本相比,快照通常包含更多的特性和更少的 bug ——它们不仅仅是为开发人员准备的!
- 1
Snapshots 是由 Sourceforge 按需创建的。您可以下载完整 trunk 目录 (docutils, sandbox, prest/perl 和 web)或任何子目录的快照。浏览到所需的目录,并单击“下载快照”按钮。
- class credits¶