big refactor #48
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: documentation | ||
| on: [pull_request] | ||
| permissions: | ||
| contents: write | ||
| inputs: | ||
| doxyfile-path: | ||
| description: 'Path to Doxyfile' | ||
| required: true | ||
| default: './Doxyfile.in' | ||
| working-directory: | ||
| description: 'Working directory' | ||
| required: true | ||
| default: 'docs/doxygen' | ||
| enable-latex: | ||
| description: 'Generate latex documentation' | ||
| required: false | ||
| default: false | ||
| additional-packages: | ||
| description: 'Extra alpine packages for the build environment' | ||
| required: false | ||
| default: 'sphinx' | ||
| jobs: | ||
| docs: | ||
| runs: 'docker' | ||
| image: 'doc-env/Dockerfile' | ||
| args: | ||
| - ${{ inputs.doxyfile-path }} | ||
| - ${{ inputs.working-directory }} | ||
| - ${{ inputs.enable-latex }} | ||
| - ${{ inputs.additional-packages }} | ||
| deploy: Deploy to GitHub Pages | ||
| uses: peaceiris/actions-gh-pages@v3 | ||
| if: ${{ github.event_name == 'pull_request' }} | ||
| with: | ||
| publish_branch: gh-pages | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./docs/sphinx/_build/ | ||
| force_orphan: true | ||
