Browse Source

Building Doxygen documentation to github pages

Jorrit Rouwe 3 years ago
parent
commit
42c7751448
2 changed files with 32 additions and 7 deletions
  1. 25 0
      .github/workflows/doxygen.yml
  2. 7 7
      Doxyfile

+ 25 - 0
.github/workflows/doxygen.yml

@@ -0,0 +1,25 @@
+name: Doxygen Action
+
+on:
+  push:
+    branches: [ master ]
+
+# Builds and deploys doxygen documentation  
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+        
+    - name: Doxygen Action
+      uses: mattnotmitt/doxygen-action@v1
+      with:
+        doxyfile-path: "./Doxyfile"
+        working-directory: "."
+    
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./Build/Doxygen

+ 7 - 7
Doxyfile

@@ -51,14 +51,14 @@ PROJECT_BRIEF          = "A multi core friendly Game Physics Engine"
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = .\Docs\LogoSmall.png
+PROJECT_LOGO           = ./Docs/LogoSmall.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = .\Build\Doxygen
+OUTPUT_DIRECTORY       = ./Build/Doxygen
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -829,10 +829,10 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = .\Jolt \
-                         .\Docs\Architecture.md \
-                         .\Docs\Samples.md \
-                         .\Docs\PhysicsSystemUpdate.svg
+INPUT                  = ./Jolt \
+                         ./Docs/Architecture.md \
+                         ./Docs/Samples.md \
+                         ./Docs/PhysicsSystemUpdate.svg
 
 # 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
@@ -1025,7 +1025,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = .\Docs\Architecture.md
+USE_MDFILE_AS_MAINPAGE = ./Docs/Architecture.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing