Skip to content

Commit

Permalink
Update workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
HanBnrd committed Aug 13, 2023
1 parent 965e803 commit c096b1a
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions .github/workflows/doc.yml → .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# This workflow will deploy the Sphinx documentation of a Python Package to GitHub Pages
# For more information see: https://coderefinery.github.io/documentation/gh_workflow

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

name: Deploy documentation

on: [push, pull_request, workflow_dispatch]
on: push

permissions:
contents: write

Expand All @@ -20,15 +15,20 @@ jobs:
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx_rtd_theme
- name: Sphinx build
run: |
sphinx-build -b html ./docs/source public
sphinx-build -b html docs/source public
- name: Upload artifacts
uses: actions/upload-artifact@v3
with:
name: html-docs
path: public
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
if: github.ref == 'refs/heads/sphinx-doc'
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: public/
publish_dir: public
force_orphan: true

0 comments on commit c096b1a

Please sign in to comment.