Jonathan R. Madsen
729c34fb60
* Add doxygen-awesome-css submodule * Basic documentation files - conf.py: run by sphinx - about.md: info about rocprofiler - features.md: overview of features - installation.md: build/test/install instructions - index.md: sets up main page - generate-doxyfile.cmake: generates rocprofiler.dox with rocprofiler-specific info - environment.yml: conda environment - Makefile: sphinx makefile - README.md: build instructions - rocprofiler.dox.in: doxygen template - .gitignore: ignores generated files - .nojekyll: prevents GitHub Pages from using Jekyll for deployment of pages * Documentation scripts - scripts for doing common sequences of commands for building docs - update-docs.sh: builds the docs and installs the docs if /docs directory is present - update-doxygen.sh: quick script for generating doxygen * Workflow for docs - step for building docs - step for deploying docs * Update doxygen comments in include/rocprofiler - rocprofiler.h / rocprofiler_plugins.h - fixed non-existent global references in doxygen comments - fixed parameter names that were incorrect or not updated * Update docs workflow - only deploy docs when on main branch
75 строки
1.7 KiB
YAML
75 строки
1.7 KiB
YAML
name: Documentation
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches: [main]
|
|
paths:
|
|
- '*.md'
|
|
- 'source/docs/**'
|
|
- 'source/scripts/update-docs.sh'
|
|
- '.github/workflows/docs.yml'
|
|
- 'VERSION'
|
|
pull_request:
|
|
branches: [main]
|
|
paths:
|
|
- '*.md'
|
|
- 'source/docs/**'
|
|
- 'source/scripts/update-docs.sh'
|
|
- '.github/workflows/docs.yml'
|
|
- 'VERSION'
|
|
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: true
|
|
|
|
env:
|
|
GIT_DISCOVERY_ACROSS_FILESYSTEM: 1
|
|
|
|
jobs:
|
|
build-docs:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
submodules: true
|
|
- name: Install Conda
|
|
uses: s-weigand/setup-conda@v1
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v2
|
|
- name: Create Docs Directory
|
|
run:
|
|
mkdir -p docs
|
|
- name: Update Docs
|
|
working-directory: source/docs
|
|
run: |
|
|
conda env create -n rocprofiler-docs -f environment.yml
|
|
source activate
|
|
conda activate rocprofiler-docs
|
|
../scripts/update-docs.sh
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v2
|
|
with:
|
|
path: ./docs
|
|
|
|
deploy-docs:
|
|
if: github.ref == 'refs/heads/main'
|
|
runs-on: ubuntu-latest
|
|
needs: build-docs
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v2
|