add API document github page (#1114)

* Doc (#66)

* add doc

* ln -s md

* add pipeline

* Update docfx.yaml

* Update docfx.yaml

* Update docfx.yaml

* Update docfx.yaml

* Update toc.yml
This commit is contained in:
Boshi Lian
2022-12-05 08:55:04 -08:00
committed by GitHub
parent 5e1297228d
commit 0918760464
5 changed files with 113 additions and 0 deletions

57
.github/workflows/docfx.yaml vendored Normal file
View File

@@ -0,0 +1,57 @@
name: Docfx
on:
push:
branches: [ master ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
docfx:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup dotnet
uses: actions/setup-dotnet@v3
with:
dotnet-version: |
3.1.x
5.0.x
6.0.x
- name: Build
run: dotnet build
- uses: nikeee/docfx-action@v1.0.0
name: Build Documentation
with:
args: doc/docfx.json
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload entire repository
path: doc/_site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1