Update documentation #96
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Update documentation | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- ".github/workflows/**" | |
- "./covsirphy/__version__.py" | |
- "docs/**" | |
workflow_dispatch: | |
jobs: | |
cancel: | |
name: cancel previous runs | |
runs-on: ubuntu-latest | |
steps: | |
- uses: styfle/cancel-workflow-action@0.11.0 | |
with: | |
all_but_latest: true | |
access_token: ${{ github.token }} | |
docs: | |
name: update documentation with Sphinx | |
runs-on: ubuntu-latest | |
steps: | |
- name: check out repository | |
uses: actions/checkout@v3 | |
- name: set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.11" | |
- name: install Poetry | |
uses: snok/install-poetry@v1 | |
with: | |
virtualenvs-create: true | |
virtualenvs-in-project: true | |
installer-parallel: true | |
- name: install dependencies | |
run: poetry install --no-interaction --with docs | |
- name: create html files with "make docs" command | |
run: make docs | |
- name: Git add & commit | |
uses: EndBug/add-and-commit@v9 | |
with: | |
add: "." | |
default_author: github_actor | |
message: "update documentation with Sphinx" | |
push: true |