Skip to content

update validators docs #92

update validators docs

update validators docs #92

Workflow file for this run

name: Docs
on:
push:
branches: [main]
paths:
- "docs/**"
- README.md
env:
PYTHON_VERSION: "3.10.14"
jobs:
docs:
runs-on: ubuntu-latest
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}-docs
cancel-in-progress: true
steps:
- uses: actions/checkout@v2
- name: Install Pandoc
run: sudo apt-get install -y pandoc
- name: Set up Python ${{ env.PYTHON_VERSION }}
uses: actions/setup-python@v2
with:
python-version: ${{ env.PYTHON_VERSION }}
- name: Install dependencies
shell: bash
run: |
pip install -r ./docs/requirements.txt
- name: Print version
run: |
python -m pip install .
python .github/scripts/print_version.py
- name: Build the docs
run: sphinx-build -b html docs/source docs/build/html
- name: Deploy the documentation on gh-pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html