Skip to content

Commit

Permalink
ci: auto-generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lewiscowles1986 committed Mar 31, 2024
1 parent 9ac3af0 commit 79a9f26
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/github-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: documentation

on: [push, pull_request, workflow_dispatch]

permissions:
contents: write

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install -r requirements/development.txt
pip install -r requirements/documentation.txt
- name: Sphinx build
run: make clean && make doc
- name: Extract branch name
shell: bash
run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
id: extract_branch
- name: Deploy to GitHub Pages (branch)
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: docs/_build/html
destination_dir: branch/${{ steps.extract_branch.outputs.branch }}
- name: Deploy to GitHub Pages
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: docs/_build/html
destination_dir: /

0 comments on commit 79a9f26

Please sign in to comment.