Skip to content

Commit 64a990f

Browse files
author
Vaibhav Balloli
authored
Create GitHub pages workflow for documentation
Signed-off-by: Vaibhav Balloli <[email protected]>
1 parent 930e5a3 commit 64a990f

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

.github/workflows/gh_pages.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Deploy HAMS's Sphinx documentation to GitHub Pages
2+
3+
# Credit: https://github.com/marketplace/actions/sphinx-to-github-pages
4+
# Runs on pushes targeting the default branch
5+
on:
6+
push:
7+
branches: [main, pre_release]
8+
9+
# Cancel any in-progress job or run
10+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency
11+
concurrency:
12+
group: ${{ github.ref }}
13+
cancel-in-progress: true
14+
15+
jobs:
16+
pages:
17+
runs-on: ubuntu-20.04
18+
environment:
19+
name: github-pages
20+
url: ${{ steps.deployment.outputs.page_url }}
21+
permissions:
22+
pages: write
23+
id-token: write
24+
steps:
25+
- id: install_pandoc
26+
run: sudo apt-get install pandoc -y
27+
- id: deployment
28+
uses: sphinx-notes/pages@v3

0 commit comments

Comments
 (0)