sphinx-json-schema 0.1b6

安装

使用pip：

pip install sphinx-json-schema

用法

将扩展名添加到您的conf.py：

extensions = [
   ...
   'sphinx_json_schema',
   ...
]

如有必要，添加根目录以查找json模式：

json_schema_root_dir = os.path.join('path', 'to', 'root', 'dir')

在您的文档中：

.. json-schema:: path/to/json/schema.json

该文件是从调用指令的.rst文件中相对查找的，如果没有，则 从conf.py文件中指定的json_schema_root_dir中找到。

allof，one of，anyof，不支持

sphinx_json_schema支持allOf、oneOf、anyOf和not关键字。它可以 还分析对其他模式的引用。最后的json输出是操作和 包含其他模式。这意味着即使原始的.json文件 很短！