FastAPI-JSONAPI/.github/workflows/documentation.yaml at main · srepmub/FastAPI-JSONAPI · GitHub

33 lines (30 loc) · 919 Bytes

# https://coderefinery.github.io/documentation/gh_workflow/

name: 📖 Docs

on:

- push

# - pull_request

# - workflow_dispatch

permissions:

contents: write

jobs:

docs:

# if: ${{ !github.event.act }} # skip during local actions testing

# if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v3

- uses: actions/setup-python@v3

- name: Install dependencies

run: |

pip install -r docs/requirements.txt

- name: Sphinx build

run: |

sphinx-build docs _build

- name: Deploy

uses: peaceiris/actions-gh-pages@v3

if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

with:

publish_branch: gh-pages

github_token: ${{ secrets.GITHUB_TOKEN }}

publish_dir: _build/

force_orphan: true

Expand file tree