Merge branch 'main' into rm-ford-6.0.0-workaround

Author: rouson

.github/workflows/CI.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on: [push, pull_request]
+
+
+jobs:
+  Build:
+    runs-on: [ubuntu-22.04]
+
+    env:
+      FC: gfortran
+      GCC_V: 12
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - uses: fortran-lang/setup-fpm@v3
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Install Dependencies Ubuntu
+      if: contains(matrix.os, 'ubuntu')
+      run: |
+        sudo apt-get update
+        sudo apt install -y gfortran-${GCC_V} build-essential
+        sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-${GCC_V} 100 \
+        --slave /usr/bin/gfortran gfortran /usr/bin/gfortran-${GCC_V} \
+        --slave /usr/bin/gcov gcov /usr/bin/gcov-${GCC_V}
+
+    - name: Build and Test
+      run: |
+        fpm test

.github/workflows/deploy-docs.yml

@@ -0,0 +1,44 @@
+name: Build and Deploy Documentation
+
+on: [push, pull_request]
+
+
+jobs:
+  Build:
+    runs-on: ubuntu-22.04
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Install Dependencies Ubuntu
+      run: |
+        sudo apt-get update
+        sudo apt install -y python3-dev python3 build-essential graphviz gfortran-12
+        sudo pip install ford
+
+    - name: Build Developer Documenation
+      run: |
+        ford doc-generator.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

README.md

@@ -28,10 +28,16 @@ The `characterizable_t` type defines an `as_character()` deferred binding that p
 
 The `intrinsic_array_t` type that extends `characterizable_t` provides a convenient mechanism for producing diagnostic output from arrays of intrinsic type `complex`, `integer`, `logical`, or `real`.
 
+Documentation
+-------------
+See [Assert's GitHub Pages site] for HTML documentation generated with [`ford`].
+
 Use Cases
 ---------
+Two common use cases include
+
 1. [Enforcing programming contracts] throughout a project via runtime checks.
-2. Produce output in `pure` procedures for debugging purposes.
+2. Producing output in `pure` procedures for debugging purposes.
 
 ### Enforcing programming contracts
 Programming can be thought of as requirements for correct execution of a procedure and assurances for the result of correct execution.
@@ -98,3 +104,5 @@ For further documentation, please see [example/README.md] and the [tests].  Also
 [FORD]: https://github.com/Fortran-FOSS-Programmers/ford
 [Fortran Package Manager]: https://github.com/fortran-lang/fpm
 [OCL]: https://en.wikipedia.org/wiki/Object_Constraint_Language
+[Assert's GitHub Pages site]: https://sourceryinstitute.github.io/assert/
+[`ford`]: https://github.com/Fortran-FOSS-Programmers/ford