Test improvements for publish website

* Improve publishing (we need to test it)
* Switch to using dev container
* Update doxygen config
* using docs-prerelease branch on fork

Note new build now only publishes on `github-pages` rather than the previous `gh-pages` as causes issues with branch protection rules.

Author: networkfusion

.devcontainer/flashcart/devcontainer.json

@@ -1,5 +1,5 @@
 {
-    "name": "N64FlashcartMenu-sc64deployer",
+    "name": "N64FlashcartMenu-flashcart-devcontainer",
     "build": {
         "dockerfile": "Dockerfile.sc64deployer"
     },

.github/workflows/publish-website.yml

@@ -1,8 +1,11 @@
-# Trigger the action on push to main
+# Trigger the action
 on:
+  pull_request:
   push:
     branches:
       - main
+      - develop
+      - docs-prerelease
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
@@ -20,29 +23,28 @@ jobs:
   publish-docs:
     environment:
       name: github-pages
-      url: menu.summercart64.dev # url: ${{ steps.deployment.outputs.page_url }}
+      url: ${{ steps.deployment.outputs.page_url }}/N64FlashcartMenu/
+
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
       uses: actions/checkout@v6
-    - name: Dotnet Setup
-      uses: actions/setup-dotnet@v5
-      with:
-        dotnet-version: 8.x
 
-    - name: Run Doxygen to generate API docs
-      uses: mattnotmitt/doxygen-action@v1
+    - name: Build N64FlashcartMenu ROM
+      uses: devcontainers/[email protected]
       with:
-        doxyfile-path: './Doxyfile'
-
-    - run: dotnet tool update -g docfx
-    - run: docfx docfx.json
+        configFile: .devcontainer/doc-builder/devcontainer.json
+        runCmd: |
+          doxygen
+          docfx docfx.json
 
     - name: Upload artifact
       uses: actions/upload-pages-artifact@v4
       with:
         # Upload entire docfx site folder
         path: '_site'
+
     - name: Deploy to GitHub Pages
+      if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/docs-prerelease'
       id: deployment
       uses: actions/deploy-pages@v4

Doxyfile

@@ -872,6 +872,7 @@ WARN_AS_ERROR          = NO
 # and the warning text. Optionally the format may contain $version, which will
 # be replaced by the version of the file (if it could be obtained via
 # FILE_VERSION_FILTER)
+# See also: WARN_LINE_FORMAT
 # The default value is: $file:$line: $text.
 
 WARN_FORMAT            = "$file:$line: $text"
@@ -905,7 +906,8 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ./src/README.md ./src
+INPUT                  = ./src/README.md \
+                         ./src
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1155,23 +1157,23 @@ VERBATIM_HEADERS       = YES
 # generated with the -Duse_libclang=ON option for CMake.
 # The default value is: NO.
 
-#CLANG_ASSISTED_PARSING = NO
+CLANG_ASSISTED_PARSING = NO
 
 # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
 # tag is set to YES then doxygen will add the directory of each input to the
 # include path.
 # The default value is: YES.
 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
 
-#CLANG_ADD_INC_PATHS    = NO
+CLANG_ADD_INC_PATHS    = YES
 
 # If clang assisted parsing is enabled you can provide the compiler with command
 # line options that you would normally use when invoking the compiler. Note that
 # the include paths will already be set by doxygen for the files and directories
 # specified with INPUT and INCLUDE_PATH.
 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
 
-#CLANG_OPTIONS          =
+CLANG_OPTIONS          =
 
 # If clang assisted parsing is enabled you can provide the clang parser with the
 # path to the directory containing a file called compile_commands.json. This
@@ -1184,7 +1186,7 @@ VERBATIM_HEADERS       = YES
 # Note: The availability of this option depends on whether or not doxygen was
 # generated with the -Duse_libclang=ON option for CMake.
 
-#CLANG_DATABASE_PATH    =
+CLANG_DATABASE_PATH    =
 
 #---------------------------------------------------------------------------
 # Configuration options related to the alphabetical class index
@@ -1666,7 +1668,7 @@ FORMULA_FONTSIZE       = 10
 # The default value is: YES.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-#FORMULA_TRANSPARENT    = YES
+FORMULA_TRANSPARENT    = YES
 
 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
 # to create new LaTeX commands to be used in formulas as building blocks. See
@@ -2280,8 +2282,8 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = "__attribute__(x)= " \
-                         "_Static_assert(c,s)= "
+PREDEFINED             = "__attribute__(x)=" \
+                         "_Static_assert(c,s)="
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The
@@ -2392,14 +2394,14 @@ DOT_NUM_THREADS        = 0
 # The default value is: Helvetica.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-#DOT_FONTNAME           = Helvetica
+DOT_FONTNAME           = Helvetica
 
 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
 # dot graphs.
 # Minimum value: 4, maximum value: 24, default value: 10.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-#DOT_FONTSIZE           = 10
+DOT_FONTSIZE           = 10
 
 # By default doxygen will tell dot to use the default font as specified with
 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
@@ -2657,7 +2659,7 @@ MAX_DOT_GRAPH_DEPTH    = 0
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-#DOT_TRANSPARENT        = NO
+DOT_TRANSPARENT        = NO
 
 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
 # files in one run (i.e. multiple -o and -T options on the command line). This