From 56d7a93b33fba811f084eeb304b8a0c73c10cd34 Mon Sep 17 00:00:00 2001 From: kjcjohnson Date: Sun, 27 Mar 2022 19:52:26 -0500 Subject: [PATCH 1/3] Add documentation job --- .github/workflows/dotnet.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml index e34e6b7..1bd9b19 100644 --- a/.github/workflows/dotnet.yml +++ b/.github/workflows/dotnet.yml @@ -152,3 +152,26 @@ jobs: - name: Publish to NuGet run: dotnet nuget push ./nupkg/*.nupkg --source $NUGET_FEED --skip-duplicate --api-key $NUGET_KEY + documentation: + runs-on: windows-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Setup .NET + uses: actions/setup-dotnet@v1 + with: + dotnet-version: 6.0.x + + - name: Setup DocFX + uses: crazy-max/ghaction-chocolatey@v1 + with: + args: install docfx + + - name: Restore + run: dotnet restore + + - name: DocFX Build + working-directory: docs + run: docfx docfx.json + continue-on-error: false From 22aec75e5c82dca28dad29bf6d59c3c193718d35 Mon Sep 17 00:00:00 2001 From: kjcjohnson Date: Sun, 27 Mar 2022 20:01:45 -0500 Subject: [PATCH 2/3] Create initial docfx configuration file --- docfx.json | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docfx.json diff --git a/docfx.json b/docfx.json new file mode 100644 index 0000000..93426e7 --- /dev/null +++ b/docfx.json @@ -0,0 +1,38 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ "**/*.sln", "*/*.csproj" ], + "exclude": [ "**/bin/**", "**/obj/**" ] + } + ], + "dest": "obj/api" + } + ], + "build": { + "content": [ + { + "files": [ "**/*.yml" ], + "src": "obj/api", + "dest": "api" + }, + { + "files": [ "articles/**/*.md", "*.md", "toc.yml", "restapi/**" ] + } + ], + "resource": [ + { + "files": [ "articles/images/**"] + } + ], + "overwrite": "specs/*.md", + "globalMetadata": { + "_appTitle": "SemGuS Parser Documentation", + "_enableSearch": true + }, + "markdownEngineName": "markdig", + "dest": "_site", + "xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ] + } +} From ed974858ec15f8a8754895fc25c1d41aa6c57c3c Mon Sep 17 00:00:00 2001 From: kjcjohnson Date: Sun, 27 Mar 2022 20:07:40 -0500 Subject: [PATCH 3/3] Fix command, upload docs --- .github/workflows/dotnet.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml index 1bd9b19..33030ab 100644 --- a/.github/workflows/dotnet.yml +++ b/.github/workflows/dotnet.yml @@ -172,6 +172,11 @@ jobs: run: dotnet restore - name: DocFX Build - working-directory: docs run: docfx docfx.json continue-on-error: false + + - name: Upload Docs + uses: actions/upload-artifact@v2 + with: + name: documentation + path: _site