Generate Github Pages from the XML Documentation

.github/workflows/generate-doc.yml

@@ -0,0 +1,32 @@
+name: C# API XML Documentation To Github Pages
+
+on: 
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+  publish-docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup dotnet
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+
+    - name: Build
+      run: dotnet build -c Release
+
+    - name: Build Documentation
+      uses: nunit/docfx-action@v3.4.2
+      with:
+        args: docs/docfx.json
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_site

.github/workflows/release.yml

@@ -8,7 +8,7 @@ on:
       release_legacy_package:
         description: 'Release legacy package'
         required: true
-        default: 'false'
+        default: false
         type: boolean
 
 jobs:

R2API.Items/README.md

@@ -16,7 +16,7 @@ Finally, ItemAPI includes the ability to add new ItemTags to the game, which can
 
 ## Related Pages
 
-A detailed tutorial on how to make custom items using ItewmAPI can be found [here](https://risk-of-thunder.github.io/R2Wiki/Mod-Creation/Assets/Items/)
+A detailed tutorial on how to make custom items using ItemAPI can be found [here](https://risk-of-thunder.github.io/R2Wiki/Mod-Creation/Assets/Items/)
 
 ## Changelog
 

R2API.Networking/NetworkingAPI.cs

@@ -12,7 +12,7 @@ namespace R2API.Networking;
 // ReSharper disable once InconsistentNaming
 /// <summary>
 /// Allow easy sending of custom networked messages, check
-/// <see href="https://github.com/risk-of-thunder/R2Wiki/wiki/Networking-with-R2API.NetworkingAPI-(INetMessage)">
+/// <see href="https://risk-of-thunder.github.io/R2Wiki/Mod-Creation/C%23-Programming/Networking/R2API.NetworkingAPI/">
 /// the tutorial for example usage.</see>
 /// </summary>
 #pragma warning disable CS0436 // Type conflicts with imported type

docs/.gitignore

@@ -0,0 +1,5 @@
+api/*.yml
+gh-pages
+dist_pdf
+api/R2API.*
+dist/

docs/api/.gitignore

@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest

docs/api/index.md

@@ -0,0 +1,7 @@
+# R2API C# API Documentation
+
+Welcome to the R2API C# API Documentation.
+
+This documentation was built from XML Docs in the C# code. Any updates or changes should be made there and submitted as a Pull Request to the project.
+
+Further documentation, guides and examples may be found in the [modding wiki](https://risk-of-thunder.github.io/R2Wiki/) and the respective R2API submodules README files

docs/docfx.json

@@ -0,0 +1,80 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "..",
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [
+            "**/obj/**",
+            "**/bin/**",
+            "_site/**",
+            "BuildCI/**",
+            "R2API.AutoVersionGen/**",
+            "R2API.Analyzer/**"
+          ]
+        }
+      ],
+      "dest": "api",
+      "disableGitFeatures": false,
+      "properties": {
+        "TargetFramework": "netstandard2.1"
+      }
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "*.md",
+          "toc.yml"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**",
+          "**/images/**"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "dest": "_site",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default"
+    ],
+    "postProcessors": [],
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": true,
+    "xref": [
+      "https://docs.microsoft.com/dotnet/xrefmap.yml"
+    ]
+  }
+}

docs/index.md

@@ -0,0 +1,7 @@
+# R2API C# API Documentation
+
+This site contains the [API Documentation for R2API](/R2API/api/).
+
+This documentation was built from XML Docs in the C# code. Any updates or changes should be made there and submitted as a Pull Request to the project.
+
+Further documentation, guides and examples may be found in the [modding wiki](https://risk-of-thunder.github.io/R2Wiki/) and the respective R2API submodules README files

docs/toc.yml

@@ -0,0 +1,2 @@
+- name: API Documentation
+  href: /R2API/api/