doc: add and deploy ford documentation

Author: everythingfunctional

.github/workflows/deploy-docs.yml

@@ -0,0 +1,43 @@
+name: Build and Deploy Documentation
+
+on: [push, pull_request]
+
+jobs:
+  Build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Install Dependencies Ubuntu
+      run: |
+        sudo apt-get update
+        sudo apt install -y python-dev python build-essential graphviz
+        sudo pip install ford
+
+    - name: Build Developer Documenation
+      run: |
+        ford doc/ford-documentation.md
+
+    - name: Upload Documentation
+      uses: actions/upload-artifact@v2
+      with:
+        name: documentation
+        path: doc/html
+        if-no-files-found: error
+
+    - name: Broken Link Check
+      if: ${{ github.ref == 'refs/heads/main'}}
+      uses: technote-space/broken-link-checker-action@v1
+      with:
+        TARGET: file://${{ github.workspace }}/doc/html/index.html
+        RECURSIVE: true
+        ASSIGNEES: ${{ github.actor }}
+
+    - name: Deploy API Documentation
+      uses: JamesIves/[email protected]
+      if: ${{ github.event_name == 'push'  &&  github.ref == 'refs/heads/main' }}
+      with:
+        branch: gh-pages
+        folder: doc/html

.gitignore

@@ -1,5 +1,6 @@
 # Build directory
 build
+doc/html
 
 # Prerequisites
 *.d

doc/ford-documentation.md

@@ -0,0 +1,25 @@
+project: FEATS
+summary: Framework for Extensible Asynchronous Task Scheduling (FEATS)
+src_dir: ../src
+output_dir: html
+preprocess: true
+macro: FORD
+preprocessor: gfortran -E
+display: public
+         protected
+         private
+source: true
+graph: true
+md_extensions: markdown.extensions.toc
+coloured_edges: true
+sort: permission-alpha
+extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html
+            iso_c_binding:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fC_005fBINDING.html#ISO_005fC_005fBINDING
+project_github: https://github.com/sourceryinstitute/feats
+author: Damian Rouson, Robert Singleterry, Harris Snyder, and Brad Richardson
+print_creation_date: true
+creation_date: %Y-%m-%d %H:%M %z
+project_download: https://github.com/sourceryinstitute/feats
+github: https://github.com/sourceryinstitute
+
+{!../README.md!}