Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
book-open

GitHub Action

Doxygen Action

v1.2.0

Doxygen Action

book-open

Doxygen Action

Generate documentation on a commented project using doxygen

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Doxygen Action

              
  uses: mattnotmitt/[email protected]
Learn more about this action in mattnotmitt/doxygen-action

Choose a version

Doxygen Docker Action

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).

Inputs

'working-directory'

Required Path of the working directory to change to before running doxygen. Default: .

'doxyfile-path'

Required 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.

Example usage (no LaTeX)

uses: mattnotmitt/doxygen-action@v1
with:
    working-directory: 'submodule/'
    doxyfile-path: 'docs/Doxygen'

Example usage (with LaTeX)

uses: mattnotmitt/doxygen-action@v1
with:
    working-directory: 'submodule/'
    doxyfile-path: 'docs/Doxygen'
    enable-latex: true