Automatic validation #8361
Workflow file for this run
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: Publish doc to GitHub Pages | |
| on: | |
| push: | |
| # Runs on every push on master branch | |
| branches: | |
| - master | |
| pull_request: | |
| paths-ignore: | |
| - 'doc/**' | |
| # Cancels running instances when a pull request is updated by a commit | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref || github.run_id }} | |
| cancel-in-progress: true | |
| env: | |
| SPHINX_VERSION: 7.2.6 | |
| jobs: | |
| doc: | |
| name: Publish doc to GitHub Pages | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/setup-python@v2 | |
| with: | |
| python-version: '3.x' | |
| - name: Checkout code | |
| uses: actions/checkout@v2 | |
| - name: Setup Sphinx and doxygen | |
| run: | | |
| sudo apt-get install doxygen | |
| sudo apt-get install -y graphviz | |
| pip install sphinx==${{ env.SPHINX_VERSION }} | |
| pip install sphinx-copybutton | |
| pip install -r doc/requirements.txt | |
| - name: Build Sphinx HTML, Doxygen and aggregate files | |
| run: | | |
| cd doc | |
| make html | |
| cp -r build/html/ aggregate/documentation | |
| cd doxygen | |
| doxygen doxygen-config-file | |
| cd .. | |
| ls -lh | |
| ls -lh doxygen | |
| cp -r doxygen/html/ aggregate/doxygen/ | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: html-doc | |
| path: doc/aggregate/ | |
| - name: Deploy to GitHub Pages | |
| uses: JamesIves/[email protected] | |
| if: github.ref == 'refs/heads/master' | |
| with: | |
| branch: gh-pages-v2 | |
| folder: doc/aggregate |