Addition of a github action to build and publish omniperf documentation using

sphinx and a rtd theme. This action is triggered via documentation-related
changes landed on the "main" branch (#22).

Signed-off-by: Karl W. Schulz <karl.schulz@amd.com>


[ROCm/rocprofiler-compute commit: ae9c284d03]
Bu işleme şunda yer alıyor:
Karl W. Schulz
2022-12-20 09:08:46 -06:00
ebeveyn a51b613ab4
işleme f5a8cc1390
+56
Dosyayı Görüntüle
@@ -0,0 +1,56 @@
name: Documentation
on:
push:
branches: ["main"]
paths:
- 'src/docs'
- '.github/workflows/docs.yml'
- 'VERSION'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Build job
build:
runs-on: ubuntu-latest
container:
image: sphinxdoc/sphinx
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Additional python packages
run: pip3 install recommonmark myst_parser sphinx_rtd_theme
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Build html
run: |
cd src/docs
make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ./src/docs/_build/html
# 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@v1