/action-ford

An action to generate documentation for a Fortran project using FORD

Primary LanguageFortranMIT LicenseMIT

This project has moved

You can now find the published action here and the repository here.

FORD docker action

This action builds documentation for a Fortran project using FORD. The documentation can then be deployed using an action such as GitHub Page.

Inputs

project_file

Required Name of the FORD project file (default project-file.md)

Outputs

output_dir

Path to the directory where documentation is written

Example usage

name: Docs

on: push

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v1
      - name: Build
        id: build
        uses: JimMadge/ford-action@v1
      - name: Deploy
        if: success()
        uses: crazy-max/ghaction-github-pages@v1
        with:
          target_branch: gh-pages
          build_dir: ${{ steps.build.outputs.output_dir }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}