ruamel yaml文档预处理器
ryd的Python项目详细描述
示例
"normal" .ryd 文件由一个文件中的多个yaml文档组成。
第一个文档在顶层有一个映射。这个 映射是此流的RYD配置数据 文档,用于定义使用的文档版本,输出 以及其他配置信息。
第一个文档后面的文档通常是块的 使用可选标记设置文字标量的样式。标记影响标量 字符串在选定的输出系统中处理:
--- version: 0.1 output: rst fix_inline_single_backquotes: true --- | Example Python program ++++++++++++++++++++++ This is an example of a python program --- !python | n = 7 print(n**2 - n) --- !stdout | The answer is::
这将(使用: ryd convert test.ryd )生成以下 test.rst :
Example Python program ++++++++++++++++++++++ This is an example of a Python program :: n = 7 print(n**2 - n) The answer is:: 42
然后可以使用 rst2pdf 将其转换为pdf,或者使用 rst2html 将其转换为html。
命令行选项
ryd的命令行由多个组件组成:
ryd [--global-option] command [--options] [arguments]
尽管没有指出,大多数全局选项也可以在命令之后出现。
命令
convert generate output as per first YAML document clean clean output files for .ryd files roundtrip roundtrip .ryd file, updating sections from-rst (fromrst) convert .rst to .ryd
您经常使用convert,它以一个或多个文件名作为参数 并生成RYD配置数据中指定的输出。有些选项允许您覆盖那里的设置(例如 --pdf 和 -没有pdf )
来自rst的命令 将一个 .rst 文件转换为 .ryd 执行某些节下划线检查并添加ryd配置数据文档。
往返命令有一个选项在适当的位置运行 在 上设置代码格式!python)-pre) 文件的 .ryd 部分。你需要 在您的路径中已经有了 oitnb 。
执行 ryd command --help可能会指示尚未进入的额外选项 文档。
文档和文档标签
每个yaml文档与其他文档分开溪流 文档开始标记。除了第一份文件,大部分 文档包含单行、多行、非缩进、标量。这个 因此,标记后面跟着管道( )符号,该符号是 多行标量的yaml指示。
通过插入 在 之前加上标签。例如,一种python程序类型的文档 有一个标签!python
文档标记的确切功能取决于标记,但也可能取决于 在以前处理的标记文档上选择的输出文件格式,其他 .ryd 以前处理过的文件和环境。 以下是所有标记的简短说明,与选定的 输出格式:
< DL> < d>!代码< dt >