Skip to content

Commit

Permalink
Update sphinx.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
lucl13 authored Aug 5, 2024
1 parent d33ecc9 commit 5956e26
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,37 @@
name: Sphinx build

on:
push:
branches:
- main
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx_issues myst_parser nbsphinx sphinx_copybutton
- name: Build HTML
uses: ammaraskar/[email protected]
with:
docs_folder: "docs/source"
build_command: "sphinx-build -b html . ../build/html"

- name: Upload artifacts
uses: actions/upload-artifact@v1
with:
name: html-docs
path: docs/build/html/

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html
publish_dir: docs/build/html

0 comments on commit 5956e26

Please sign in to comment.