Skip to content

Add documentation job #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kjcjohnson wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add documentation job #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
56d7a93
Add documentation job
kjcjohnson Mar 28, 2022
22aec75
Create initial docfx configuration file
kjcjohnson Mar 28, 2022
ed97485
Fix command, upload docs
kjcjohnson Mar 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/dotnet.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,3 +152,31 @@ 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
run: docfx docfx.json
continue-on-error: false

- name: Upload Docs
uses: actions/upload-artifact@v2
with:
name: documentation
path: _site
38 changes: 38 additions & 0 deletions docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}" ]
}
}