Skip to content

Commit 6dc9810

Browse files
authored
Migrate documentation to Docfx (#852)
* Remove doxygen config. * Move samples to NWN.Anvil.Samples. * Adjust namespaces. * Add docfx config. * Import GitHub wiki docs. * Update code doc references to use docfx markdown. * Add doc CI pipeline. * Update namespace ignore rules.
1 parent 2731262 commit 6dc9810

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+1717
-658
lines changed

.github/workflows/docs.yml

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,48 @@
11
name: Docs
22
on:
33
push:
4-
branches: [ main ]
4+
branches:
5+
- main
6+
- development
7+
8+
permissions:
9+
actions: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
517
jobs:
618
deploy:
19+
environment:
20+
name: github-pages
21+
url: ${{ steps.deploy.outputs.page_url }}
722
runs-on: ubuntu-latest
823
steps:
924
- name: Checkout
1025
uses: actions/checkout@v4
26+
with:
27+
submodules: recursive
1128

12-
- name: Doxygen Action
13-
uses: mattnotmitt/doxygen-action@v1
29+
- name: Setup .NET
30+
uses: actions/setup-dotnet@v4
1431
with:
15-
doxyfile-path: "./docs/Doxyfile"
16-
working-directory: "."
32+
global-json-file: global.json
1733

18-
- name: Deploy
19-
uses: peaceiris/actions-gh-pages@v4
34+
- name: Install DocFX
35+
run: dotnet tool update -g docfx
36+
37+
- name: Build Docs
38+
run: docfx docfx.json
39+
working-directory: docs
40+
41+
- name: Upload Docs
42+
uses: actions/upload-pages-artifact@v3
2043
with:
21-
github_token: ${{ secrets.GITHUB_TOKEN }}
22-
publish_dir: ./docs/html
23-
commit_message: "Automated Commit: Update docs"
44+
path: 'docs/html'
45+
46+
- name: Deploy Docs to GitHub Pages
47+
id: deploy
48+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,3 +357,4 @@ crashlytics.properties
357357
crashlytics-build.properties
358358
fabric.properties
359359
docs/html
360+
docs/api
File renamed without changes.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
2+
<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=src_005Cmain/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

docs/samples/API/Async/NwTaskExamples.cs renamed to NWN.Anvil.Samples/src/main/API/Async/NwTaskExamples.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
using Anvil.API;
1010
using Anvil.Services;
1111

12-
namespace NWN.Anvil.Samples
12+
namespace NWN.Anvil.Samples.Async
1313
{
1414
[ServiceBinding(typeof(NwTaskExamples))]
1515
public class NwTaskExamples

docs/samples/API/EngineStructures/CassowaryExamples.cs renamed to NWN.Anvil.Samples/src/main/API/EngineStructures/CassowaryExamples.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
using Anvil.Services;
77
using NLog;
88

9-
namespace NWN.Anvil.Samples
9+
namespace NWN.Anvil.Samples.EngineStructures
1010
{
1111
[ServiceBinding(typeof(CassowaryExamples))]
1212
public class CassowaryExamples

docs/samples/API/EngineStructures/EffectExamples.cs renamed to NWN.Anvil.Samples/src/main/API/EngineStructures/EffectExamples.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
using Anvil.API.Events;
99
using Anvil.Services;
1010

11-
namespace NWN.Anvil.Samples
11+
namespace NWN.Anvil.Samples.EngineStructures
1212
{
1313
[ServiceBinding(typeof(EffectExamples))]
1414
public class EffectExamples

docs/samples/API/EngineStructures/ItemPropertyExamples.cs renamed to NWN.Anvil.Samples/src/main/API/EngineStructures/ItemPropertyExamples.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
using Anvil.API.Events;
77
using Anvil.Services;
88

9-
namespace NWN.Anvil.Samples
9+
namespace NWN.Anvil.Samples.EngineStructures
1010
{
1111
[ServiceBinding(typeof(ItemPropertyExamples))]
1212
public class ItemPropertyExamples

docs/samples/Services/BasicScriptHandler.cs renamed to NWN.Anvil.Samples/src/main/Services/BasicScriptHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
// The "ServiceBinding" attribute indicates this class should be created on start, and available to other classes as a dependency "MyScriptHandler"
1010
// You can also bind yourself to an interface or base class. The system also supports multiple bindings.
11-
namespace NWN.Anvil.Samples
11+
namespace NWN.Anvil.Samples.Services
1212
{
1313
[ServiceBinding(typeof(BasicScriptHandler))]
1414
public class BasicScriptHandler

docs/samples/Services/ChatHandler.cs renamed to NWN.Anvil.Samples/src/main/Services/ChatHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
using Anvil.API.Events;
99
using Anvil.Services;
1010

11-
namespace NWN.Anvil.Samples
11+
namespace NWN.Anvil.Samples.Services
1212
{
1313
// Our base chat command interface...
1414
public interface IChatCommand

0 commit comments

Comments
 (0)