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

Added documentation page title

Browse Source
This commit is contained in:
penev92
2022-09-15 11:07:46 +03:00
committed by Matthias Mailänder
parent eda3dfa50f
commit 07b9c941b4
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
packaging/format-docs.py
View File

@@ -38,14 +38,19 @@ def format_docs(version, collectionName, types, relatedEnums):
# Map the `relatedEnums` collection to a list of strings.
enumNames = [enum['Name'] for enum in relatedEnums]
title = ""
explanation = ""
if collectionName == "TraitInfos":
title = "Traits"
explanation = "all traits with their properties and their default values plus developer commentary"
elif collectionName == "WeaponTypes":
title = "Weapons"
explanation = "a template for weapon definitions and the types it can use (warheads and projectiles) with default values and developer commentary"
elif collectionName == "SpriteSequenceTypes":
title = "Sprite sequences"
explanation = "all sprite sequence types with their properties and their default values plus developer commentary"
print(f"# {title}\n")
print(f"This documentation is aimed at modders and has been automatically generated for version `{version}` of OpenRA. " +
"Please do not edit it directly, but instead add new `[Desc(\"String\")]` tags to the source code.\n")