setup-fortran-conda GitHub

Doxygen

Install Doxygen and Graphviz, build project documentation from the configured Doxyfile and deploy the generated output to the selected branch.

Inputs

Input Default Value
generate-doc-doxygen false Build and deploy Doxygen documentation
doxygen-config Doxyfile Configuration file relative to the working directory
doxygen-branch gh-pages-doxygen Deployment branch
doxygen-working-directory . Working directory relative to the repository root
doxygen-output-directory doc/doxygen Generated directory relative to the repository root
doxygen-target-folder doc/doxygen Deployment target folder

Permissions

Doxygen reads Actions job metadata and writes the generated documentation to the selected deployment branch. 

permissions:
  actions: read
  contents: write

Usage

Enabling Doxygen installs Doxygen and Graphviz. The Doxyfile must generate its output in doxygen-output-directory. 

doc_doxygen:
  name: Generate Doxygen Documentation
  runs-on: ubuntu-latest
  permissions:
    actions: read
    contents: write
  steps:
    - name: Setup and Generate Doxygen Documentation
      uses: gha3mi/setup-fortran-conda@latest
      with:
        compiler: gfortran
        generate-doc-doxygen: true
        doxygen-working-directory: .
        doxygen-config: Doxyfile
        doxygen-output-directory: doc/doxygen
        doxygen-branch: gh-pages-doxygen
        doxygen-target-folder: doc/doxygen