Skip to content

Commit

Permalink
Create build-docs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
styx0x6 authored Oct 16, 2024
1 parent 9728995 commit 2f9aa35
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Build Sphinx documentation and deploy to GitHub Pages

# Controls when the workflow will run
on:
# Triggers the workflow on push events but only for the "main" branch
push:
branches: [ "main" ]

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

# Cancel any in-progress job or run
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency
concurrency:
group: ${{ github.ref }}
cancel-in-progress: true

jobs:
# This workflow contains a single job called "build"
build:
runs-on: ubuntu-latest

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

permissions:
pages: write
id-token: write

steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4

- id: deployment
uses: sphinx-notes/pages@v3

0 comments on commit 2f9aa35

Please sign in to comment.