From 53fada4a300444612234acf92ec6459f2a02d554 Mon Sep 17 00:00:00 2001 From: Max Schmitt Date: Sun, 13 Sep 2020 01:00:02 +0200 Subject: [PATCH] devops: deploy docs to GitHub Pages (#185) --- .github/workflows/deploy-docs.yml | 25 +++++++++++++++++++++++++ .gitignore | 1 + local-requirements.txt | 1 + 3 files changed, 27 insertions(+) create mode 100644 .github/workflows/deploy-docs.yml diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 000000000..c599e307f --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -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 diff --git a/.gitignore b/.gitignore index 86bc5f983..d5d3c2364 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,4 @@ htmlcov/ _repo_version.py coverage.xml junit/ +docs/ diff --git a/local-requirements.txt b/local-requirements.txt index 2f3008270..5f43ce4e8 100644 --- a/local-requirements.txt +++ b/local-requirements.txt @@ -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