Skip to content

Commit

Permalink
devops: deploy docs to GitHub Pages (#185)
Browse files Browse the repository at this point in the history
  • Loading branch information
mxschmitt authored Sep 12, 2020
1 parent 8654434 commit 53fada4
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Deploy docs
on:
push:
branches: [ master ]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r local-requirements.txt
pip install -e .
- name: Generate docs
run: pdoc3 --html -o docs playwright
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ htmlcov/
_repo_version.py
coverage.xml
junit/
docs/
1 change: 1 addition & 0 deletions local-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ flake8==3.8.3
twine==3.2.0
pyOpenSSL==19.1.0
service_identity==18.1.0
pdoc3==0.9.1

0 comments on commit 53fada4

Please sign in to comment.