Skip to content

Commit 53fada4

Browse files
authored
devops: deploy docs to GitHub Pages (#185)
1 parent 8654434 commit 53fada4

File tree

3 files changed

+27
-0
lines changed

3 files changed

+27
-0
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Deploy docs
2+
on:
3+
push:
4+
branches: [ master ]
5+
jobs:
6+
deploy:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v2
10+
- name: Set up Python
11+
uses: actions/setup-python@v2
12+
with:
13+
python-version: 3.8
14+
- name: Install dependencies
15+
run: |
16+
python -m pip install --upgrade pip
17+
pip install -r local-requirements.txt
18+
pip install -e .
19+
- name: Generate docs
20+
run: pdoc3 --html -o docs playwright
21+
- name: Deploy
22+
uses: peaceiris/actions-gh-pages@v3
23+
with:
24+
github_token: ${{ secrets.GITHUB_TOKEN }}
25+
publish_dir: ./docs

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ htmlcov/
1717
_repo_version.py
1818
coverage.xml
1919
junit/
20+
docs/

local-requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ flake8==3.8.3
1616
twine==3.2.0
1717
pyOpenSSL==19.1.0
1818
service_identity==18.1.0
19+
pdoc3==0.9.1

0 commit comments

Comments
 (0)