Parser for Yaml/JSon schemas to RST

jsonschema2rst的Python项目详细描述


此项目旨在解析json模式yaml模式,以便创建 重组文本文档。 使用sphinx这样的工具,可以创建高可读性的文档 从生成的文件,这些文件是RST格式的文本。

结果rst可以通过在csv中定义黑名单并使用 自定义css文件。会继承狮身人面像的。对于后者,一个 提供了示例。

用法

要从json架构(或yaml)创建rst文件,请运行命令:

jsonschema2rst input_folder output_folder

此命令将接受此路径、子文件夹中的所有json或yaml文件 包含,并且WLL创建一个新目录——如果已经存在,则删除它。 所有解析的rst文件将被放置在哪里。

示例

假设您运行以下命令:

jsonschema2rst json_folder rst_output_folder

假设文件夹json_folder包含 url.json,其中包含以下架构:

{
    "title": "URL of related document",
    "properties": {
        "description": {
            "type": "string"
        },
        "value": {
            "format": "url",
            "type": "string"
        }
    },
    "type": "object"
}

因此,jsonschema2rst将创建一个名为url.rstin的文件 rst_output_folder将包含以下RST代码:

.. contents:: Table of Contents
.. section-numbering::
.. container:: section-title
 url.json

.. container:: title

 URL of related document

**type** : ``object``

**Properties:** description_, value_


.. description:

description
+++++++++++

**type** : ``string``


.. value:

value
+++++


**type** : ``string``

**format** : ``url``

额外

如果您想使用sphinx这样的工具生成html文档,我们 建议您尝试contribution文件夹中的custom.css文件 您的模式文档看起来更好。你需要的只是把 sphinx在conf.py文件中使用的默认css,然后 享受吧!

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
Java泛型重写抽象方法并具有子类的返回类型   Java中的字符串反转字符,同时保留一些字符   java将系统时间与我获取它的时间进行比较   java解析ODATA URL以在准备entityset之前读取ID值   java中的有界通配符下界泛型即使在传递超类时也不会编译   c#Java的JVM和Java的内部工作方式有什么不同。NET的CLR?   java如何在windows7上指定JDK的版本?   Java:列出单个目录中的所有文件(1020000+)   java使用Logback和Lombok   安卓谷歌玩java。lang.NullPointerException   使用RSA的解密结果在普通Java和Android中有所不同   具有默认连接池的java Spring引导   java我如何在一个坏的测试环境中前进?