docs: update contents #131
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: build-docs | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- '.github/workflows/build-docs.yml' | |
- 'docs/**' | |
- 'sscma/**' | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: checkout repository | |
uses: actions/checkout@v2 | |
with: | |
ref: 'main' | |
- name: install dependencies | |
run: sudo apt-get install doxygen graphviz -y | |
- name: build docs | |
run: doxygen docs/Doxyfile.in | |
- name: upload artifact | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: docs/html | |
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@v2 |