Skip to content

Update README.md

Update README.md #33

Workflow file for this run

name: Build Docs
on:
# Runs on pushes targeting the default branch
push:
branches: [main] #[$default-branch]
tags:
- v*
# 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 one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Install Sphinx/Doxygen
run: |
sudo apt update
sudo apt install -y doxygen graphviz python3-pip
- name: Install pip requirements
run: |
ls -l
pip3 install -r ./docs/sphinx/requirements.txt
- name: Build docs
working-directory: ./docs/
run: |
bash build_branch_docs.sh
- name: Build Website
working-directory: ./docs/
run: |
ls build
mkdir -p /tmp/gh-pages
cp -r ./build/* /tmp/gh-pages/.
touch /tmp/gh-pages/.nojekyll
ls /tmp/gh-pages
- uses: actions/upload-artifact@master
with:
name: gh-page
path: /tmp/gh-pages
if-no-files-found: error
# Deployment job
deploy:
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- uses: actions/download-artifact@master
with:
name: gh-page
path: /tmp/gh-pages
- uses: actions/configure-pages@v1
- uses: actions/upload-pages-artifact@v1
with:
path: /tmp/gh-pages
- id: deployment
uses: actions/deploy-pages@main