Feature: doxygen documentation #7
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: generate docs | |
| on: | |
| push: | |
| branches: [main, development] | |
| pull_request: | |
| branches: [main, development] | |
| release: | |
| types: [released] | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| container: | |
| image: ghcr.io/dnkpp/gcc:14 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # we must configure, because the Doxyfile is generated via cmake | |
| - name: Configure | |
| run: | | |
| cmake \ | |
| -S . \ | |
| -B build \ | |
| --log-level=VERBOSE \ | |
| -DMIMICPP_CONFIGURE_DOXYGEN=ON \ | |
| -DMIMICPP_BUILD_TESTS=OFF \ | |
| -DMIMICPP_BUILD_EXAMPLES=OFF | |
| - name: Generate Doxygen Documentation (html and pdf) | |
| uses: mattnotmitt/doxygen-action@edge | |
| with: | |
| doxyfile-path: build/docs/Doxyfile | |
| enable-latex: true | |
| - name: Upload html documentation | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: HTML-Documentation | |
| path: build/docs/html | |
| - name: Upload pdf documentation | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: Latex-Documentation | |
| path: build/docs/latex |