Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Script to Build Docs via Docker #1713

Merged
merged 5 commits into from
Nov 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@
*.png binary
*.jpg binary
*.paa binary

/tools/make_docs eol=lf
/tools/make_docs_docker eol=lf
Binary file modified store/function_library.tar
Binary file not shown.
2 changes: 1 addition & 1 deletion tools/make_docs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

shopt -s xpg_echo 2>/dev/null || :

NATURALDOCS=`which naturaldocs 2>/dev/null`
NATURALDOCS=`which NaturalDocs 2>/dev/null || which naturaldocs 2>/dev/null`

if [ -z $NATURALDOCS ]
then
Expand Down
13 changes: 13 additions & 0 deletions tools/make_docs_docker
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#!/bin/bash

docker build . -t natural-docs-1-52 -f tools/natural-docs.dockerfile

docker run -d -i -t -v "$(pwd)/:/cba" --name CBA_A3_Make_Docs natural-docs-1-52

docker exec CBA_A3_Make_Docs apt install fakeroot -y;
docker exec CBA_A3_Make_Docs chmod +x cba/tools/make_docs
docker exec CBA_A3_Make_Docs /bin/bash -c "cd cba/tools/; ./make_docs"

docker kill CBA_A3_Make_Docs

docker rm CBA_A3_Make_Docs
17 changes: 17 additions & 0 deletions tools/natural-docs.dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
FROM debian:latest

RUN apt update

RUN apt install wget unzip perl -y

RUN wget https://sourceforge.net/projects/naturaldocs/files/Stable%20Releases/1.52/NaturalDocs-1.52.zip/download -O /NaturalDocs.zip

RUN unzip NaturalDocs.zip -d NaturalDocs

RUN rm NaturalDocs.zip

RUN chmod +x /NaturalDocs/NaturalDocs

ENV PATH=/NaturalDocs:$PATH

CMD ["/bin/bash"]
2 changes: 1 addition & 1 deletion tools/ndocs-project/Languages.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Format: 1.51
Format: 1.52

# This is the Natural Docs languages file for this project. If you change
# anything here, it will apply to THIS PROJECT ONLY. If you'd like to change
Expand Down
27 changes: 26 additions & 1 deletion tools/ndocs-project/Menu.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Format: 1.51
Format: 1.52


Title: CBA
Expand Down Expand Up @@ -62,6 +62,7 @@ Group: Functions {
Group: Accessory {

File: CBA_accessory_fnc_switchAttachment (accessory/fnc_switchAttachment.sqf)
File: CBA_fnc_addAttachmentCondition (accessory/fnc_addAttachmentCondition.sqf)
File: CBA_fnc_switchableAttachments (accessory/fnc_switchableAttachments.sqf)
} # Group: Accessory

Expand Down Expand Up @@ -119,12 +120,22 @@ Group: Functions {
File: CBA_fnc_binocularMagazine (common/fnc_binocularMagazine.sqf)
File: CBA_fnc_canAddItem (common/fnc_canAddItem.sqf)
File: CBA_fnc_canUseWeapon (common/fnc_canUseWeapon.sqf)
File: CBA_fnc_colorAHEXtoDecimal (common/fnc_colorAHEXtoDecimal.sqf)
File: CBA_fnc_colorARGBtoDecimal (common/fnc_colorARGBtoDecimal.sqf)
File: CBA_fnc_colorHEXAtoDecimal (common/fnc_colorHEXAtoDecimal.sqf)
File: CBA_fnc_colorHEXtoDecimal (common/fnc_colorHEXtoDecimal.sqf)
File: CBA_fnc_colorRGBAtoDecimal (common/fnc_colorRGBAtoDecimal.sqf)
File: CBA_fnc_colorRGBtoDecimal (common/fnc_colorRGBtoDecimal.sqf)
File: CBA_fnc_compatibleMagazines (common/fnc_compatibleMagazines.sqf)
File: CBA_fnc_compileFinal (common/fnc_compileFinal.sqf)
File: CBA_fnc_createMarker (common/fnc_createMarker.sqf)
File: CBA_fnc_createNamespace (common/fnc_createNamespace.sqf)
File: CBA_fnc_createPerFrameHandlerObject (common/fnc_createPerFrameHandlerObject.sqf)
File: CBA_fnc_createTrigger (common/fnc_createTrigger.sqf)
File: CBA_fnc_createUUID (common/fnc_createUUID.sqf)
File: CBA_fnc_cssColorToDecimal (common/fnc_cssColorToDecimal.sqf)
File: CBA_fnc_cssColorToHEX (common/fnc_cssColorToHEX.sqf)
File: CBA_fnc_cssColorToTexture (common/fnc_cssColorToTexture.sqf)
File: CBA_fnc_currentMagazineIndex (common/fnc_currentMagazineIndex.sqf)
File: CBA_fnc_currentUnit (common/fnc_currentUnit.sqf)
File: CBA_fnc_deleteEntity (common/fnc_deleteEntity.sqf)
Expand All @@ -134,6 +145,8 @@ Group: Functions {
File: CBA_fnc_dropItem (common/fnc_dropItem.sqf)
File: CBA_fnc_dropMagazine (common/fnc_dropMagazine.sqf)
File: CBA_fnc_dropWeapon (common/fnc_dropWeapon.sqf)
File: CBA_fnc_escapeRegex (common/fnc_escapeRegex.sqf)
File: CBA_fnc_execAfterNFrames (common/fnc_execAfterNFrames.sqf)
File: CBA_fnc_execNextFrame (common/fnc_execNextFrame.sqf)
File: CBA_fnc_findEntity (common/fnc_findEntity.sqf)
File: CBA_fnc_getActiveFeatureCamera (common/fnc_getActiveFeatureCamera.sqf)
Expand Down Expand Up @@ -205,6 +218,7 @@ Group: Functions {
File: CBA_fnc_waitAndExecute (common/fnc_waitAndExecute.sqf)
File: CBA_fnc_waitUntilAndExecute (common/fnc_waitUntilAndExecute.sqf)
File: CBA_fnc_weaponComponents (common/fnc_weaponComponents.sqf)
File: CBA_fnc_weekDay (common/fnc_weekDay.sqf)
} # Group: Common

Group: Diagnostic {
Expand All @@ -225,6 +239,7 @@ Group: Functions {

File: CBA_events_fnc_playerEvent (events/fnc_playerEvent.sqf)
File: CBA_fnc_addBISEventHandler (events/fnc_addBISEventHandler.sqf)
File: CBA_fnc_addBISPlayerEventHandler (events/fnc_addBISPlayerEventHandler.sqf)
File: CBA_fnc_addDisplayHandler (events/fnc_addDisplayHandler.sqf)
File: CBA_fnc_addEventHandler (events/fnc_addEventHandler.sqf)
File: CBA_fnc_addEventHandlerArgs (events/fnc_addEventHandlerArgs.sqf)
Expand All @@ -240,6 +255,7 @@ Group: Functions {
File: CBA_fnc_readKeyFromConfig (events/fnc_readKeyFromConfig.sqf)
File: CBA_fnc_registerChatCommand (events/fnc_registerChatCommand.sqf)
File: CBA_fnc_remoteEvent (events/fnc_remoteEvent.sqf)
File: CBA_fnc_removeBISPlayerEventHandler (events/fnc_removeBISPlayerEventHandler.sqf)
File: CBA_fnc_removeDisplayHandler (events/fnc_removeDisplayHandler.sqf)
File: CBA_fnc_removeEventHandler (events/fnc_removeEventHandler.sqf)
File: CBA_fnc_removeGlobalEventJIP (events/fnc_removeGlobalEventJIP.sqf)
Expand Down Expand Up @@ -288,6 +304,12 @@ Group: Functions {
File: CBA_fnc_registerKeybindToFleximenu (keybinding/fnc_registerKeybindToFleximenu.sqf)
} # Group: Keybinding

Group: Loadout {

File: CBA_fnc_getLoadout (loadout/fnc_getLoadout.sqf)
File: CBA_fnc_setLoadout (loadout/fnc_setLoadout.sqf)
} # Group: Loadout

Group: Modules {

File: CBA_fnc_getPosFromString (modules/fnc_getPosFromString.sqf)
Expand Down Expand Up @@ -354,6 +376,7 @@ Group: Functions {
File: CBA_fnc_formatElapsedTime (strings/fnc_formatElapsedTime.sqf)
File: CBA_fnc_formatNumber (strings/fnc_formatNumber.sqf)
File: CBA_fnc_leftTrim (strings/fnc_leftTrim.sqf)
File: CBA_fnc_prettyFormat (strings/fnc_prettyFormat.sqf)
File: CBA_fnc_removeWhitespace (strings/fnc_removeWhitespace.sqf)
File: CBA_fnc_replace (strings/fnc_replace.sqf)
File: CBA_fnc_rightTrim (strings/fnc_rightTrim.sqf)
Expand All @@ -374,7 +397,9 @@ Group: Functions {
File: CBA_fnc_getFov (ui/fnc_getFov.sqf)
File: CBA_fnc_getUISize (ui/fnc_getUISize.sqf)
File: CBA_fnc_notify (ui/fnc_notify.sqf)
File: CBA_fnc_openLobbyManager (ui/fnc_openLobbyManager.sqf)
File: CBA_fnc_progressBar (ui/fnc_progressBar.sqf)
File: CBA_fnc_renameInventoryItem (ui/fnc_renameInventoryItem.sqf)
} # Group: Ui

Group: Vectors {
Expand Down
2 changes: 1 addition & 1 deletion tools/ndocs-project/Topics.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Format: 1.51
Format: 1.52

# This is the Natural Docs topics file for this project. If you change anything
# here, it will apply to THIS PROJECT ONLY. If you'd like to change something
Expand Down
Loading