From 07b9c941b47c399e7599a10d46fd37d5f46059e1 Mon Sep 17 00:00:00 2001 From: penev92 Date: Thu, 15 Sep 2022 11:07:46 +0300 Subject: [PATCH] Added documentation page title --- packaging/format-docs.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packaging/format-docs.py b/packaging/format-docs.py index ae8749893e..51f77229b2 100644 --- a/packaging/format-docs.py +++ b/packaging/format-docs.py @@ -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")