epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Python documentation script

Browse Source
This commit is contained in:
Pavel Penev
2025-01-09 11:31:56 +02:00
committed by Gustas
parent dfa922de91
commit 5f9e0ffd43
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
packaging/format-docs.py
View File

@@ -85,7 +85,7 @@ def format_docs(version, collectionName, types, relatedEnums):
formattedRequiredTraits = [format_type_name(x, is_known_type(x, types)) for x in currentType["RequiresTraits"]] formattedRequiredTraits = [format_type_name(x, is_known_type(x, types)) for x in currentType["RequiresTraits"]]
print("\n> Requires trait(s): " + ", ".join(sorted(formattedRequiredTraits)) + '.') print("\n> Requires trait(s): " + ", ".join(sorted(formattedRequiredTraits)) + '.')
if len(currentType["Properties"]) > 0: if currentType["Properties"] and len(currentType["Properties"]) > 0:
print() print()
print(f'| Property | Default Value | Type | Description |') print(f'| Property | Default Value | Type | Description |')
print(f'| -------- | ------------- | ---- | ----------- |') print(f'| -------- | ------------- | ---- | ----------- |')
@@ -102,7 +102,7 @@ def format_docs(version, collectionName, types, relatedEnums):
else: else:
enumReferences[prop["InternalType"]] = [currentType["Name"]] enumReferences[prop["InternalType"]] = [currentType["Name"]]
if "OtherAttributes" in prop: if prop.get("OtherAttributes", None) is not None:
attributes = [] attributes = []
for attribute in prop["OtherAttributes"]: for attribute in prop["OtherAttributes"]:
attributes.append(attribute["Name"]) attributes.append(attribute["Name"])
@@ -120,7 +120,7 @@ def format_docs(version, collectionName, types, relatedEnums):
if len(relatedEnums) > 0: if len(relatedEnums) > 0:
print('\n# Related value types (enums):\n') print('\n# Related value types (enums):\n')
for relatedEnum in relatedEnums: for relatedEnum in relatedEnums:
values = [f"`{value['Value']}`" for value in relatedEnum["Values"]] values = [f"`{value}`" for value in relatedEnum["Values"].values()]
print(f"### {relatedEnum['Name']}") print(f"### {relatedEnum['Name']}")
print(f"Possible values: {', '.join(values)}\n") print(f"Possible values: {', '.join(values)}\n")
distinctReferencingTypes = sorted(set(enumReferences[relatedEnum['Name']])) distinctReferencingTypes = sorted(set(enumReferences[relatedEnum['Name']]))
@@ -132,5 +132,9 @@ if __name__ == "__main__":
jsonInfo = json.load(input_stream) jsonInfo = json.load(input_stream)
keys = list(jsonInfo) keys = list(jsonInfo)
if len(keys) == 3 and keys[0] == 'Version': if len(keys) >= 2 and keys[0] == 'Version':
format_docs(jsonInfo[keys[0]], keys[1], jsonInfo[keys[1]], jsonInfo[keys[2]]) version = jsonInfo[keys[0]]
collectionName = keys[1]
types = jsonInfo[keys[1]]
relatedEnums = jsonInfo["RelatedEnums"] or []
format_docs(version, collectionName, types, relatedEnums)