Skip to content

Commit c0b109e

Browse files
kolerovabrodkin
authored andcommitted
doc: Add workflow for documentation
1 parent db00552 commit c0b109e

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: "Build and deploy doumentation"
2+
on:
3+
push:
4+
paths:
5+
- doc/**
6+
7+
pull_request:
8+
paths:
9+
- doc/**
10+
11+
workflow_dispatch:
12+
inputs:
13+
perform_deploy:
14+
description: 'Perform deploy to GitHub Pages branch'
15+
required: true
16+
default: false
17+
type: boolean
18+
19+
jobs:
20+
doc-build-and-deploy:
21+
name: Build and deploy documentation
22+
runs-on: ubuntu-22.04
23+
24+
steps:
25+
- name: Checkout repository
26+
uses: actions/checkout@v3
27+
28+
- name: Build documentation
29+
uses: ammaraskar/[email protected]
30+
with:
31+
docs-folder: doc
32+
33+
- name: Deploy documentation
34+
if: ${{ github.event_name == 'workflow_dispatch' && inputs.perform_deploy }}
35+
uses: JamesIves/github-pages-deploy-action@v4
36+
with:
37+
branch: gh-pages
38+
folder: doc/_build/html

0 commit comments

Comments
 (0)