Skip to content

Commit

Permalink
HTML documentation deployment on github.
Browse files Browse the repository at this point in the history
  • Loading branch information
illinoisrobert committed Oct 8, 2024
1 parent a9ae452 commit 98d5112
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Sample workflow for building and deploying a mdBook site to GitHub Pages
#
# To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html
#
name: Deploy Linux RST site to Pages

on:
push:
tags:
- 'v[0-9]*-memorizer-*'

# 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 only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
# env:
# MDBOOK_VERSION: 0.4.36
steps:
- uses: actions/checkout@v4
- name: Install sphinx
run: sudo apt install -y python3-sphinx graphviz
# curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
# rustup update
# cargo install --version ${MDBOOK_VERSION} mdbook

# What does actions/configure-pages@v5 do?
# - name: Setup Pages
# id: pages
# uses: actions/configure-pages@v5
# - name: Build with mdBook
# run: mdbook build
- name: Build htmldocs
run: make htmldocs
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./Documentation/output/

# 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@v4

0 comments on commit 98d5112

Please sign in to comment.