This repository has been archived by the owner on Apr 13, 2023. It is now read-only.
Check documentation #678
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: Check documentation | |
"on": | |
schedule: | |
- cron: "0 1 * * *" # everyday at 1am | |
push: | |
paths: | |
- "**.md" | |
- "docs/**" | |
pull_request: | |
paths: | |
- "**.md" | |
- "docs/**" | |
jobs: | |
docs: | |
name: Build documentation & check links | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: "3.11" | |
- name: Upgrade pip | |
run: | | |
pip install --constraint=.github/workflows/constraints.txt pip | |
pip --version | |
- name: Install Poetry | |
run: | | |
pipx install --pip-args=--constraint=.github/workflows/poetry-constraints.txt poetry | |
poetry --version | |
- name: Install Nox | |
run: | | |
pipx install --pip-args=--constraint=.github/workflows/constraints.txt nox | |
pipx inject --pip-args=--constraint=.github/workflows/constraints.txt nox nox-poetry | |
nox --version | |
- name: Build documentation | |
run: nox --force-color --session=docs-build | |
- name: Upload documentation | |
uses: actions/upload-artifact@v3 | |
with: | |
name: docs | |
path: docs/_build |