Skip to content
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
49 changes: 49 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Documentation

on:
push:
branches: [main]
paths:
- 'addons/**'
- 'NaturalDocs.Project/**'
- '.github/workflows/docs.yml'

permissions:
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
build-and-deploy:
runs-on: ubuntu-latest

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: '8.0.x'

- name: Install Natural Docs
run: dotnet tool install --global Natural_Docs --version 2.3.1

- name: Generate documentation
run: NaturalDocs NaturalDocs.Project --rebuild

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs-output

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ hemtt.exe

.hemttprivatekey
*.biprivatekey

docs-output/
6 changes: 6 additions & 0 deletions NaturalDocs.Project/Languages.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Language: SQF

Extensions: sqf hpp

Line Comments: //
Block Comments: /* */
6 changes: 6 additions & 0 deletions NaturalDocs.Project/Project.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Title: OCAP2
Subtitle: Operations Capture and Playback

Source Folder: ../addons

HTML Output Folder: ../docs-output
43 changes: 0 additions & 43 deletions docs/files/extension/fnc_sendData-sqf.html

This file was deleted.

Loading