Fix API docs

auth0 · Dec 18, 2023 · d928c33 · d928c33
1 parent 487646f
commit d928c33
Show file tree

Hide file tree

Showing 12 changed files with 71 additions and 24 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,59 @@
+name: Generate API docs
+
+on:
+  workflow_dispatch:
+
+  push:
+    branches: ["fix/api-docs"]
+
+permissions:
+  contents: read
+
+jobs:
+  generate-docs:
+    name: Generate API docs
+    runs-on: windows-latest
+    environment: 'release'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.inputs.branch }}
+
+      - name: Install Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+
+      - name: Install .NET
+        uses: actions/setup-dotnet@v3
+
+      - name: Install .NET Android and iOS workload
+        run: dotnet workload install android ios
+
+      - name: Setup NuGet
+        uses: nuget/setup-nuget@v1
+
+      - name: Restore NuGet
+        run: nuget restore Auth0.OidcClient.All.sln
+
+      - name: Setup MSBuild
+        uses: microsoft/setup-msbuild@v1.1
+
+      - name: Build
+        run: msbuild Auth0.OidcClient.All.sln -t:rebuild -verbosity:diag -property:Configuration=Release
+
+      - name: Install DocFX
+        run: dotnet tool install -g docfx
+
+      - name: Build docs
+        run: ./tools/build-docs.sh
+        shell: bash
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: docs
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -58,18 +58,6 @@ jobs:
           nuget pack nuget/Auth0.OidcClient.WinForms.nuspec
           nuget pack nuget/Auth0.OidcClient.WPF.nuspec
 
-      - name: Install DocFX
-        run: dotnet tool install -g docfx
-
-      - name: Build docs
-        run: ./tools/build-docs.sh
-        shell: bash
-
-      - uses: actions/upload-artifact@v3
-        with:
-          name: docs
-          path: docs
-
       - uses: actions/upload-artifact@v3
         with:
           name: drop

diff --git a/src/Auth0.OidcClient.Android/docs-source/docfx.json b/src/Auth0.OidcClient.Android/docs-source/docfx.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",
@@ -26,7 +26,7 @@
               "bin/Release/**/mscorlib.dll",
               "bin/Release/**/System*.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ]
 

diff --git a/src/Auth0.OidcClient.Android/docs-source/docfx.local.json b/src/Auth0.OidcClient.Android/docs-source/docfx.local.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",
@@ -26,7 +26,7 @@
               "bin/Release/**/mscorlib.dll",
               "bin/Release/**/System*.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ]
 

diff --git a/src/Auth0.OidcClient.UWP/docs-source/docfx.json b/src/Auth0.OidcClient.UWP/docs-source/docfx.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.UWP/docs-source/docfx.local.json b/src/Auth0.OidcClient.UWP/docs-source/docfx.local.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.WPF/docs-source/docfx.json b/src/Auth0.OidcClient.WPF/docs-source/docfx.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.WPF/docs-source/docfx.local.json b/src/Auth0.OidcClient.WPF/docs-source/docfx.local.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.WinForms/docs-source/docfx.json b/src/Auth0.OidcClient.WinForms/docs-source/docfx.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.WinForms/docs-source/docfx.local.json b/src/Auth0.OidcClient.WinForms/docs-source/docfx.local.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.iOS/docs-source/docfx.json b/src/Auth0.OidcClient.iOS/docs-source/docfx.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",

diff --git a/src/Auth0.OidcClient.iOS/docs-source/docfx.local.json b/src/Auth0.OidcClient.iOS/docs-source/docfx.local.json
@@ -7,7 +7,7 @@
               "bin/Release/**/Auth0.OidcClient.dll",
               "bin/Release/**/Auth0.OidcClient.Core.dll"
             ],
-            "cwd": "../"
+            "src": "../"
           }
         ],
         "dest": "api",