Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattnotmitt/doxygen-action
GitHub Action for generating Doxygen documentation for your projects.
https://github.com/mattnotmitt/doxygen-action
actions doxygen github-actions latex
Last synced: 12 days ago
JSON representation
GitHub Action for generating Doxygen documentation for your projects.
- Host: GitHub
- URL: https://github.com/mattnotmitt/doxygen-action
- Owner: mattnotmitt
- License: mit
- Created: 2020-03-05T13:58:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-03T14:49:04.000Z (9 months ago)
- Last Synced: 2024-10-14T10:57:59.792Z (24 days ago)
- Topics: actions, doxygen, github-actions, latex
- Language: Shell
- Homepage:
- Size: 38.1 KB
- Stars: 102
- Watchers: 2
- Forks: 38
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Doxygen Docker Action
This [GitHub Action](https://github.com/features/actions) will build [doxygen](http://doxygen.nl/) docs from the specified doxyfile.
Use with an action such as [actions-gh-pages](https://github.com/peaceiris/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](https://www.gnu.org/software/freefont/) package (FreeSans, FreeMono and FreeSerif) or in any package listed in `additional-packages`.
## Versions
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.
### Supported Tags
| Action Version | Doxygen Version | Alpine Version | Tag Aliases |
|----------------|------------------|----------------|-------------|
| edge | 1.10.0-r0 | edge | |
| 1.9.8 | 1.9.8-r0 | 3.19 | v1, 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 |
## Inputs
### 'working-directory'
**Optional** Path of the working directory to change to before running doxygen. Default: `.`
### 'doxyfile-path'
**Optional** Path of the Doxyfile relative to the working directory. Default: `./Doxyfile`.
### 'enable-latex'
**Optional** Flag to enable `make`-ing of the LaTeX part of the doxygen output. Default: `false`.
### 'additional-packages'
**Optional** Additional [Alpine packages](https://pkgs.alpinelinux.org/packages) to install in the environment (i.e. font packages)
## Example usage with additional font package
```yaml
uses: mattnotmitt/[email protected]
with:
additional-packages: font-fira-code
```
## Example usage with set working dir and doxyfile path (no LaTeX)
```yaml
uses: mattnotmitt/[email protected]
with:
working-directory: 'submodule/'
doxyfile-path: 'docs/Doxygen'
```
## Example usage (with LaTeX)
```yaml
uses: mattnotmitt/[email protected]
with:
working-directory: 'submodule/'
doxyfile-path: 'docs/Doxygen'
enable-latex: true
```