Skip to content

Commit

Permalink
docs: Added Github Actions workflow to publish Sphinx doc on Github P…
Browse files Browse the repository at this point in the history
…ages
  • Loading branch information
flozz committed Mar 28, 2024
1 parent e9280c1 commit cc8a941
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: "Build and deploy Github pages"

on:
push:
branches: master

jobs:

build-and-deploy:

name: "Build and deploy Sphinx documentation"
runs-on: ubuntu-latest

steps:

- name: "Checkout the repository"
uses: actions/checkout@v4
with:
persist-credentials: false
submodules: true

- name: "Set up Python"
uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: "Install Python dependencies"
run: |
pip3 install setuptools nox
- name: "Build Sphinx Doc"
run: |
nox -s gendoc
- name: "Deploy Github Pages"
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: build/html/

0 comments on commit cc8a941

Please # to comment.