用于生成structuredtext的简单python api。
rstcloth的Python项目详细描述
背景和目标
structuredtext是一种强大的以人为中心的标记语言,它是 定义良好,灵活,具有强大的工具,使写作和 轻松愉快地维护文本。人类可以编辑 在没有复杂编辑工具的帮助下重新构造文本,以及 结果源易于操作和处理。
resturedtext的一个关键特性是 完整的扩展api,使脆弱性最小化成为可能 源文件中的重复结构,增加了 生产。而您可以使用这些扩展来构建 轻松定制内容类型,扩展使重构的文本源更少 可移植,不太直观的编辑为临时贡献者。
作为替代和补充,rstcloth是 编写格式良好的重构文本。rstcloth公司 方便:
- 将数据驱动的内容视图生成到现有的重构文本中 环境和工具。
- 自动生成和修改内容,而无需创建 不可传送的重组文本。
- 通过使用 透明中间格式。
示例使用
以下rstcloth代码:
from rstcloth import RstCloth d = RstCloth() d.title('Example Use') d.newline() d.h2('Contents') d.directive(name="contents", fields=[('local', ''), ('backlinks', 'None')]) d.newline() d.h2('Code -- shebang') d.codeblock('#!/usr/bin/env') d.print_content()
将导致以下重构文本:
=========== Example Use =========== Contents -------- .. contents:: :local: :backlinks: None Code -- shebang --------------- :: #!/usr/bin/env
状态
rstcloth正在进行中的开发和扩展 目前稳定。当前功能和项目包括:
- 改进文档。
- 开发单元测试框架以确保一致的api行为。
- 构建/扩展表生成api。
- 改进段落级内容生成api。
见issue tracker 以获得当前和未来项目的更完整列表。
项目
源存储库:canonical git.cyborginstitute.net repository具有 github mirror。
问题跟踪程序:cyborg institute bugzilla。
listserv:cyborg institute listserv。