Skip to content

Documentation

Documentation #170

Workflow file for this run

name: deploydoxy
on:
push:
branches: [ main, doc-deploy ]
pull_request:
branches: [ main ]
#d
jobs:
gen_doxygen:
name: generate doxygen for gh-pages
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v2
with:
persist-credentials: false
- name: cd to repo
run: cd $GITHUB_WORKSPACE
- name: install doxygen
run: sudo apt-get install -y doxygen
- name: run doxy
run: |
sudo apt update
sudo apt install libxerces-c-dev
sudo apt-get install python3-sphinx
pip3 install breathe
pip3 install sphinx_rtd_theme
mkdir build && cd build
cmake .. -DCREATE_DOXYGEN_TARGET=ON && make doxygen
cd ../docs
sphinx-build . sphinx/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/sphinx