Merge pull request #7 from mercedes-benz/andlaus-patch-1 #4
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: documentation | |
on: | |
push: | |
branches: | |
- main | |
workflow_dispatch: | |
permissions: | |
contents: write | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v3 | |
- name: Install sphinx dependencies dependencies | |
run: | | |
pip install sphinx sphinx_rtd_theme myst_parser sphinx_copybutton | |
- name: Install doxygen | |
run: | | |
sudo apt-get update | |
sudo apt-get install -y doxygen | |
- name: Build documentation | |
run: | | |
cd doc | |
make html | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
# if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
with: | |
publish_branch: gh-pages | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: doc/_build/html/ | |
force_orphan: true |