Skip to content

Commit 73871d6

Browse files
committed
Updated the documentation generation docfx-publish yaml action file to handle the new docfx source of a compiled assembly.
1 parent 5284bac commit 73871d6

2 files changed

Lines changed: 21 additions & 19 deletions

File tree

.github/workflows/docfx-publish.yml

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,31 @@ permissions:
1515
concurrency:
1616
group: "pages"
1717
cancel-in-progress: false
18-
18+
1919
jobs:
2020
publish-docs:
2121
environment:
2222
name: github-pages
2323
url: ${{ steps.deployment.outputs.page_url }}
2424
runs-on: ubuntu-latest
2525
steps:
26-
- name: Checkout
27-
uses: actions/checkout@v4
28-
- name: Dotnet Setup
29-
uses: actions/setup-dotnet@v4
30-
with:
31-
dotnet-version: 9.x
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
- name: Dotnet Setup
29+
uses: actions/setup-dotnet@v4
30+
with:
31+
dotnet-version: 9.x
3232

33-
- run: dotnet tool update -g docfx
34-
- run: docfx Source/Docs/docfx.json
33+
- run: dotnet restore Source/KZDev.PerfUtils.sln
34+
- run: dotnet build -c Release Source/Src/KZDev.PerfUtils/KZDev.PerfUtils.csproj
35+
- run: dotnet tool update -g docfx
36+
- run: docfx Source/Docs/docfx.json
3537

36-
- name: Upload artifact
37-
uses: actions/upload-pages-artifact@v3
38-
with:
39-
# Upload entire site directory
40-
path: 'Source/Docs/_site'
41-
- name: Deploy to GitHub Pages
42-
id: deployment
43-
uses: actions/deploy-pages@v4
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v3
40+
with:
41+
# Upload entire site directory
42+
path: "Source/Docs/_site"
43+
- name: Deploy to GitHub Pages
44+
id: deployment
45+
uses: actions/deploy-pages@v4

Source/Docs/docfx.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"src": [
55
{
66
"src": "../../artifacts/bin/KZDev.PerfUtils/release_net9.0",
7-
"dest": "api/net9",
7+
"dest": "api",
88
"cwd": "src",
99
"properties": {
1010
"TargetFramework": "net9"
@@ -14,7 +14,7 @@
1414
]
1515
}
1616
],
17-
"dest": "api/net9",
17+
"dest": "api",
1818
"filter": "filterConfig.yml",
1919
"outputFormat": "mref",
2020
"memberLayout": "separatePages",

0 commit comments

Comments
 (0)