Skip to content

Commit

Permalink
Added FORD documentation gh-pages workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
eamousing committed Sep 30, 2024
1 parent c053f76 commit 9140ad2
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
46 changes: 46 additions & 0 deletions .github/workflows/ford.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: FORD

on:
push:
branches: [ "docs" ]
pull_request:
branches: [ "docs" ]

jobs:
documentation:
runs-on: ${{ matrix.os }}
permissions:
contents: write
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
python-version: [3.12]

steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Install python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}

- name: Setup Graphviz
uses: ts-graphviz/setup-graphviz@v1

- name: Install FORD
if: contains( matrix.os, 'ubuntu' )
run: |
python -m pip install --upgrade pip
pip install ford
- name: Build FORD documentation
run: ford ./ford.md

- name: Deploy documentation
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: doc

1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ NILU/Not_used
*.i90
*.i
uEMEPv*
ford*

# Build directories and files
debug/
Expand Down

0 comments on commit 9140ad2

Please sign in to comment.