mirror of
https://github.com/quay/quay.git
synced 2026-01-26 06:21:37 +03:00
a06cc6fa43
* chore(pre-commit): match black version with requirements-dev * run `make black` against repo * ci: switch to black 24.4.2 * fix: py312 * fix: flake8 errors * fix: flake8 conflicts * chore: add git blame ignore revs file
55 lines
1.4 KiB
Python
55 lines
1.4 KiB
Python
"""
|
|
Generates html documentation from JSON Schema.
|
|
"""
|
|
|
|
import json
|
|
from collections import OrderedDict
|
|
|
|
import docsmodel
|
|
import html_output
|
|
|
|
from util.config.schema import CONFIG_SCHEMA
|
|
|
|
|
|
def make_custom_sort(orders):
|
|
"""
|
|
Sort in a specified order any dictionary nested in a complex structure.
|
|
"""
|
|
|
|
orders = [{k: -i for (i, k) in enumerate(reversed(order), 1)} for order in orders]
|
|
|
|
def process(stuff):
|
|
if isinstance(stuff, dict):
|
|
l = [(k, process(v)) for (k, v) in stuff.items()]
|
|
keys = set(stuff)
|
|
for order in orders:
|
|
if keys.issubset(order) or keys.issuperset(order):
|
|
return OrderedDict(sorted(l, key=lambda x: order.get(x[0], 0)))
|
|
return OrderedDict(sorted(l))
|
|
if isinstance(stuff, list):
|
|
return [process(x) for x in stuff]
|
|
return stuff
|
|
|
|
return process
|
|
|
|
|
|
def main():
|
|
SCHEMA_HTML_FILE = "schema.html"
|
|
|
|
schema = json.dumps(CONFIG_SCHEMA, sort_keys=True)
|
|
schema = json.loads(schema, object_pairs_hook=OrderedDict)
|
|
|
|
req = sorted(schema["required"])
|
|
custom_sort = make_custom_sort([req])
|
|
schema = custom_sort(schema)
|
|
|
|
parsed_items = docsmodel.DocsModel().parse(schema)[1:]
|
|
output = html_output.HtmlOutput().generate_output(parsed_items)
|
|
|
|
with open(SCHEMA_HTML_FILE, "wt") as f:
|
|
f.write(output)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|