Skip to content

Commit ee8ab21

Browse files
authored
Merge pull request #5 from ChristopherJTrent/main
Setup Doxygen
2 parents 6a205a6 + 5c6caa7 commit ee8ab21

22 files changed

Lines changed: 2955 additions & 84 deletions

.github/workflows/doxygen.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Build and Deploy Doxygen docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-24.04
12+
permissions:
13+
id-token: write
14+
pages: write
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v6.0.2
18+
with:
19+
submodules: recursive
20+
- name: Configure Pages
21+
uses: actions/configure-pages@v5.0.0
22+
- run: |
23+
mkdir ./assets
24+
curl -o ./assets/favicon.png "https://raidcore.gg/favicon.png"
25+
- name: Build Doxygen
26+
uses: mattnotmitt/doxygen-action@1.12.0
27+
- name: Upload Artifact
28+
uses: actions/upload-pages-artifact@v4.0.0
29+
with:
30+
path: ./docs/html/
31+
- name: Deploy Site
32+
uses: actions/deploy-pages@v4.0.5

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/

.gitmodules

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
[submodule "AddonHost/API/Nexus"]
2-
path = AddonHost/API/Nexus
3-
url = https://github.com/RaidcoreGG/RCGG-lib-nexus-api
4-
[submodule "AddonHost/API/Definitions"]
5-
path = AddonHost/API/Definitions
6-
url = https://github.com/RaidcoreGG/RCGG-lib-nexus-api
1+
[submodule "modules/nexus"]
2+
path = modules/nexus
3+
url = https://github.com/RaidcoreGG/RCGG-lib-nexus-api.git
4+
[submodule "modules/arcdps"]
5+
path = modules/arcdps
6+
url = https://github.com/RaidcoreGG/RCGG-lib-arcdps-api.git
7+
[submodule "modules/mumble"]
8+
path = modules/mumble
9+
url = https://github.com/RaidcoreGG/RCGG-lib-mumble-api.git

.vscode/settings.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"emeraldwalk.runonsave": {
3+
"shell": "powershell.exe",
4+
"commands": [
5+
{
6+
"match": ".*.md",
7+
"cmd": "doxygen"
8+
}
9+
]
10+
}
11+
}

BOUNTIES.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Documentation Bounties
2+
This document contains a list of bounties that the maintainers have sponsored. Bounty payments are to exclusively be in the form of GW2 Gold, and must be paid by the individual who sponsored them. Inspired by [On Wiki of Gold](https://wiki.guildwars2.com/wiki/Guild_Wars_2_Wiki:Projects/On_Wiki_of_Gold)
3+
4+
| Bounty Target | Amount | Sponsor |
5+
| - | - | - |
6+
| Update pages/guides/Events.md to include examples for `AddonAPI_t::Events_RaiseTargeted` and `AddonAPI_t::Events_RaiseNotificationTargeted` | 10 gold | Arkevorkhat.8651 |

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Contributions are welcome.
2+
Please make your best effort to match the style of the other documents in this repository.
3+
See [the Doxygen docs](https://www.doxygen.nl/manual/markdown.html) for info on how to write markdown for our docs.
4+
.dox files will not be accepted.

0 commit comments

Comments
 (0)