Skip to content

Commit

Permalink
Deploy documentation on Github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
dmohns committed Jan 31, 2024
1 parent d3b5bd2 commit 55b3e0f
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/deploy-gh-pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy GitHub Pages with Sphinx-docs

on:
# Runs on pushes targeting the default branch
push:
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: pages
cancel-in-progress: true

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Install Sphinx and plugins
run: |
pipx install sphinx
pipx inject sphinx recommonmark
pipx inject sphinx sphinx_rtd_theme
- name: Build docs with Sphinx-docs
working-directory: docs
run: make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: docs/build/

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,7 @@ docker-compose-prod-non-domain.yml
docker-compose-prod.yml
install-production.sh
.gitlab-ci.yml

# Sphinx documentation
docs/_build/
docs/build/

0 comments on commit 55b3e0f

Please sign in to comment.