Add CI workflow using Ford documentation (#33)

- Add a new file: .github/workflows/ford.yml to automate documentation build and deployment.

.github/workflows/ford.yml

@@ -0,0 +1,48 @@
+name: FORD
+
+on:
+ push:
+ branches: [ "main" ]
+ pull_request:
+ branches: [ "main" ]
+
+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
+ with:
+ submodules: recursive
+
+ - 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
+ if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+ - name: Build FORD Documentation
+ run: ford ./ford.yml
+
+ - name: Deploy Documentation
+ uses: JamesIves/[email protected]
+ with:
+ branch: gh-pages
+ folder: doc