Skip to content

Add RDMA example doc (#228) #14

Add RDMA example doc (#228)

Add RDMA example doc (#228) #14

name: Documentation Build and Publish
on:
workflow_call:
workflow_dispatch:
push:
branches: [ "main" ]
env:
DEBIAN_FRONTEND: noninteractive
permissions:
contents: read
jobs:
publishGitHubPages:
name: Publish GitHub Pages
permissions:
contents: read
id-token: write
pages: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- name: Secure the runner
uses: step-security/harden-runner@17d0e2bd7d51742c71671bd19fa12bdc9d40a3d6 # v2.8.1
with:
egress-policy: audit
- name: Checkout
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- name: Prepare operating system for documentation build
run: |
sudo apt-get update -y && \
sudo apt-get install -y --no-install-recommends make python3 python3-pip python3-sphinx
- name: Prepare environment for documentation build
run: python3 -m pip install sphinx_book_theme myst_parser sphinxcontrib.mermaid sphinx-copybutton
- name: Build documentation
run: make -C docs/sphinx html
- name: Upload GitHub Pages artifact
uses: actions/[email protected]
with:
path: ./docs/_build/html
- name: Publish to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4