From dc8ff93a8ca896ff2ee465ad3135317a331acfea Mon Sep 17 00:00:00 2001 From: dutchie031 Date: Sat, 10 May 2025 17:34:33 +0200 Subject: [PATCH] updated configuration documentation automation --- .github/workflows/static_pages.yml | 8 ++++ _docs/pages/reference.html | 76 +----------------------------- 2 files changed, 10 insertions(+), 74 deletions(-) diff --git a/.github/workflows/static_pages.yml b/.github/workflows/static_pages.yml index 2db9169..ac82be1 100644 --- a/.github/workflows/static_pages.yml +++ b/.github/workflows/static_pages.yml @@ -116,6 +116,14 @@ jobs: sed -i '/@@API_CODE@@/d' _docs/pages/spearheadapi.html rm _docs/pages/temp_api_code.html + - name: Highlight API code and update HTML + run: | + pygmentize -f html -l lua -O noclasses,style=monokai classes/api/SpearheadApiDoc.lua > _docs/pages/temp_config_code.html + # Insert the highlighted code into the placeholder in spearheadapi.html + sed -i '/@@CONFIG_CODE@@/r _docs/pages/temp_config_code.html' _docs/pages/reference.html + sed -i '/@@CONFIG_CODE@@/d' _docs/pages/reference.html + rm _docs/pages/temp_config_code.html + - name: Setup Pages uses: actions/configure-pages@v5 - name: Upload artifact diff --git a/_docs/pages/reference.html b/_docs/pages/reference.html index 71ddcdb..3a2d817 100644 --- a/_docs/pages/reference.html +++ b/_docs/pages/reference.html @@ -96,80 +96,8 @@ 

-SpearheadConfig = {
-
-    CapConfig = {
-        --quickly enable of disable the entire CAP Logic 
-        --(you can also just rename all units to not be named "CAP_")
-        enabled = true, -- default true
-        
-        --min ground speed for CAP aircraft during patrol
-        -- unit: knots
-        minSpeed = 400, -- default 400
-
-        --max speed for CAP aircraft during patrol
-        -- unit: knots
-        maxSpeed = 500, -- default 500
-
-        --minAlt for aircraft on patrol
-        -- unit: feet
-        minAlt = 18000, -- default 18000
-
-        --maxAlt for aircraft on patrol
-        -- unit: feet
-        maxAlt = 28000, -- default 28000
-
-        --Delay for aircraft from touchdown to off the chocks.
-        -- unit: seconds
-        rearmDelay = 600, -- default 600
-
-        --Delay for aircraft from death to takeoff.
-        --When the seconds remaining is the same at the rearmDelay it will be spawned on the ramp and follow the rearm logic.
-        -- !! Can not be lower than rearmDelay
-        -- unit: seconds
-        deathDelay = 1800, -- default 1800
-    },
-    StageConfig = {
-        
-        -- management of stages and its missions. 
-        -- This is not related to CAP managers which will continue to work even if stage management is disabled
-        enabled = true, -- default true
-
-        --Will draw the active and the next stage 
-        drawStages = true, -- default true
-
-        --AutoStages will continue to the next stage automatically on completion of the missions within the stage. 
-        -- If you want to make it so the next stage triggers only when you want to disable it here and manually implement the actions needed.
-        --[
-            TODO: Add manual stage transition documentation
-        ]]
-        autoStages = true, --default true
-
-        --Maximum missions per stage (includes all types of missions)
-        maxMissionStage = 10,
-
-        --Stage starting number
-        startingStage = 1,
-
-        ---DEBUG logging. Consider keeping this disabled
-        debugEnabled = false
-    },
-    Persistence = {
-        --- io and lfs cannot be sanitized in the MissionScripting.lua
-        
-        --- enables or disables the persistence logic in spearhead
-        enabled = false,
-
-        --- sets the directory where the persistence file is stored
-        --- if nil then lfs.writedir() will be used. 
-        --- which will 
-        directory = nil,
-
-        --- the filename of the persistence file. Should end with .json for convention, but any text extension should do.
-        fileName = "Spearhead_Persistence.json"
-
-    }
-}
+ @@CONFIG_CODE@@ +

Naming Conventions