setup-fortran-conda GitHub

FORD

Install FORD, Graphviz and pip, build project documentation from the configured input file and deploy the generated output to the selected branch.

Inputs

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

Permissions

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

permissions:
  actions: read
  contents: write

Usage

Enabling FORD installs FORD, Graphviz and pip. The FORD configuration must generate its output in ford-output-directory. 

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