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.0.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 according to a specified Doxyfile - if omitted will search in the root directory of the repo.

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

'doxyfile-path'

Required Path of the Doxyfile relative to the repository root. Default: ./Doxyfile.

Example usage

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