Skip to content

doc: github action build document #6

doc: github action build document

doc: github action build document #6

Workflow file for this run

name: Documentation Build and Deploy
on:
push:
branches:
- master
- jingru-github-ci-flow
paths:
- 'doc/**'
- '**.rst'
- '**.md'
- '.github/workflows/doc-build.yml'
jobs:
doc-build-html:
name: "Documentation Build (HTML)"
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v2
- name: install-pkgs
run: |
sudo apt-get install -y doxygen
- name: cache-pip
uses: actions/cache@v2
with:
path: ~/.cache/pip
key: pip-${{ hashFiles('.github/workflows/requirements_doc.txt') }}
- name: install-pip
run: |
sudo pip3 install -U setuptools wheel pip
pip3 install -r .github/workflows/requirements_doc.txt
- name: build-docs
run: |
SPHINXOPTS="-q -W -j auto" make -C doc doxygen
SPHINXOPTS="-q -W -j auto" make -C doc html
rm -rf doc/build/doctrees
- name: Deploy
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: doc/build
target-folder: doc/build