Doxygen Action
ActionsTags
(2)This GitHub Action will build doxygen docs from the specified doxyfile.
Use with an action such as actions-gh-pages to deploy to your project's GitHub pages site!
NOTE: If you are using dot/graphviz in your doxygen config to generate diagrams the only fonts installed, and hence can be used are those in the GNU FreeFont package (FreeSans, FreeMono and FreeSerif) or in any package listed in additional-packages.
Previously, versions of this action incremented as changes were made to the repo. However, this has now been changed so the tagged versions of this action match the doxygen versions they relate to.
An edge tag has been created, tracking the version of doxygen available on the alpine edge tag.
| Action Version | Doxygen Version | Alpine Version | Tag Aliases |
|---|---|---|---|
| edge | 1.13.2-r0 | edge | |
| 1.12.0 | 1.12.0-r0 | 3.21 | v1, v1.12 |
| 1.11.0 | 1.11.0-r0 | 3.20 | v1, v1.11 |
| 1.9.8 | 1.9.8-r0 | 3.19 | v1.9 |
| 1.9.6 | 1.9.6-r1 | 3.18 | |
| 1.9.5 | 1.9.5-r0 | 3.17 | |
| 1.9.4 | 1.9.4-r0 | 3.16 | |
| 1.9.2 | 1.9.2-r1 | 3.15 | |
| 1.9.1 | 1.9.1-r1 | 3.14 | |
| 1.8.18 | 1.8.18-r0 | 3.12 | v1.8 |
Optional Path of the working directory to change to before running doxygen. Default: .
Note
If you want to use a fully qualified path, note that ${{ github.workspace }} / $GITHUB_WORKSPACE directory
is mounted at /github/workspace within the Docker container.
See the GitHub actions docs for more information.
Optional Path of the Doxyfile relative to the working directory. Default: ./Doxyfile.
Optional Flag to enable make-ing of the LaTeX part of the doxygen output. Default: false.
Optional Additional Alpine packages to install in the environment (i.e. font packages)
uses: mattnotmitt/[email protected]
with:
additional-packages: font-fira-codeuses: mattnotmitt/[email protected]
with:
working-directory: 'submodule/'
doxyfile-path: 'docs/Doxygen'uses: mattnotmitt/[email protected]
with:
working-directory: 'submodule/'
doxyfile-path: 'docs/Doxygen'
enable-latex: true
Doxygen Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(2)Doxygen Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.