Skip to content

Commit cc27afb

Browse files
author
Francesco Rizzi
committed
doc auto deploy
1 parent 08515c1 commit cc27afb

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

.github/workflows/deploy_docs.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Deploy docs
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
7+
jobs:
8+
build-and-deploy-docs:
9+
runs-on: ubuntu-latest
10+
env:
11+
docs-directory: /home/runner/work/pressio-tutorials/pressio-tutorials/docs
12+
python-version: '3.10'
13+
14+
steps:
15+
- uses: actions/checkout@v3
16+
- name: Set up Python ${{ env.python-version }}
17+
uses: actions/setup-python@v4
18+
with:
19+
python-version: ${{ env.python-version }}
20+
architecture: 'x64'
21+
- name: Install Python dependencies
22+
run: |
23+
pip3 install -r ./py_requirements.txt
24+
- name: Build documentation
25+
working-directory: ${{ env.docs-directory }}
26+
run: |
27+
make html
28+
# .nojekyll file is needed for GitHub Pages to know it's getting a ready webpage
29+
# and there is no need to generate anything
30+
- name: Generate nojekyll file
31+
working-directory: ${{ env.docs-directory }}/generated_docs
32+
run: touch .nojekyll
33+
# This action moves the content of `generated_docs` to the branch from where
34+
# the site is published
35+
- name: Deploy docs
36+
uses: JamesIves/github-pages-deploy-action@v4
37+
with:
38+
branch: website-deployment
39+
folder: ${{ env.docs-directory }}/generated_docs
40+
clean: true

0 commit comments

Comments
 (0)