-
Notifications
You must be signed in to change notification settings - Fork 0
31 lines (26 loc) · 881 Bytes
/
docs.yml
File metadata and controls
31 lines (26 loc) · 881 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# This is a basic workflow to help you get started with Actions
name: DocFX
# Controls when the action will run.
on:
push:
branches: [ main ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
build_docs:
runs-on: ubuntu-latest
name: Generate Clockwork Api Documentation
steps:
- uses: actions/checkout@v1
# ...
- uses: nikeee/docfx-action@v1.0.0
name: Build Documentation
with:
args: docfx.json
# Publish generated site using GitHub Pages
- uses: maxheld83/ghpages@master
name: Publish Documentation on GitHub Pages
env:
BUILD_DIR: _site # docfx's default output directory is _site
GH_PAT: ${{ secrets.GH_PAT }} # See https://github.com/maxheld83/ghpages