Skip to content

Commit

Permalink
add doc builder to use gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
DocOtak committed Dec 14, 2024
1 parent e460d07 commit 3dd6bb1
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Build Docs

on:
push:
branches: [ master ]

workflow_dispatch:

jobs:
docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: 'pip'
cache-dependency-path: setup.py

- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install '.[complete]'
- name: Sphinx Build HTML docs
working-directory: docs
run: make html

- name: Deploy
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html

0 comments on commit 3dd6bb1

Please sign in to comment.