Skip to content

ci: inits documentation workflow #1

ci: inits documentation workflow

ci: inits documentation workflow #1

Workflow file for this run

name: documentation
on:
push:
branches: ["15-refining-docstrings-for-code-api-enhancement"]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- uses: abatilo/actions-poetry@v2
- name: Install dependencies
run: |
poetry install
- name: Sphinx build
run: |
sphinx-build ./docs ./docs/_build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/
force_orphan: true