jsonschema2rst 0.1.6

使用方法

要从JSON模式（或YAML）创建RST文件，请运行以下命令

jsonschema2rst input_folder output_folder

此命令将取路径中所有JSON或YAML文件，包括子文件夹，并将创建一个新目录（如果已存在则将其删除），其中将放置所有解析的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将在rst_output_folder中创建一个名为url.rst的文件，其中将包含以下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文档，我们建议您尝试在贡献文件夹中的自定义.css文件，以使您的模式文档看起来更好。您需要做的只是将Sphinx在conf.py文件中使用的默认CSS替换为提出的CSS，然后享受吧！