feat(CI and docs)

.github/workflows/CI.yml

@@ -0,0 +1,70 @@
+name: CI
+on: [push]
+
+jobs:
+  Build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        gcc_v: [10] # Version of GFortran we want to use.
+        python-version: [3.9]
+    env:
+      FC: gfortran-${{ matrix.gcc_v }}
+      GCC_V: ${{ matrix.gcc_v }}
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+      with:
+        submodules: recursive
+
+    - name: Install Python
+      uses: actions/setup-python@v1 # Use pip to install latest CMake, & FORD/Jin2For, etc.
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Setup Graphviz
+      uses: ts-graphviz/setup-graphviz@v1
+
+    - name: Setup Fortran Package Manager
+      uses: fortran-lang/setup-fpm@v4
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Install Python dependencies
+      if: contains( matrix.os, 'ubuntu')
+      run: |
+        python -m pip install --upgrade pip
+        pip install ford numpy matplotlib
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+    - name: Install GFortran Linux
+      if: contains( matrix.os, 'ubuntu')
+      run: |
+        sudo apt-get install lcov
+        sudo update-alternatives \
+           --install /usr/bin/gcc gcc /usr/bin/gcc-${{ matrix.gcc_v }} 100 \
+           --slave /usr/bin/gfortran gfortran /usr/bin/gfortran-${{ matrix.gcc_v }} \
+           --slave /usr/bin/gcov gcov /usr/bin/gcov-${{ matrix.gcc_v }}
+
+    # - name: Compile
+    #   run: fpm build --profile release
+
+    - name: Run tests
+      run: fpm test --profile debug --flag -coverage
+
+    # - name: Create coverage report
+    #   run: |
+    #     mkdir -p ${{ env.COV_DIR }}
+    #     lcov --capture --initial --base-directory . --directory build/gfortran_*/ --output-file ${{ env.COV_DIR }}/coverage.base
+    #     lcov --capture --base-directory . --directory build/gfortran_*/ --output-file ${{ env.COV_DIR }}/coverage.capture
+    #     lcov --add-tracefile ${{ env.COV_DIR }}/coverage.base --add-tracefile ${{ env.COV_DIR }}/coverage.capture --output-file ${{ env.COV_DIR }}/coverage.info
+    #   env:
+    #     COV_DIR: build/coverage
+
+    # - name: Upload coverage report
+    #   uses: codecov/codecov-action@v2
+    #   with:
+    #     files: build/coverage/coverage.info

.github/workflows/docs.yml

@@ -0,0 +1,48 @@
+name: Build and Deploy Documentation
+
+on: [push, pull_request]
+
+jobs:
+  documentation:
+    runs-on: ubuntu-22.04
+
+    env:
+      FC: gfortran
+      GCC_V: 12
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Install Dependencies Ubuntu
+      run: |
+        sudo apt-get update
+        sudo apt install -y gfortran-${GCC_V} python3-dev graphviz
+        sudo pip install ford markdown==3.3.4
+
+    - name: Build Developer Documentation
+      run: |
+        ford doc/ford-front-matter.md
+
+    - name: Upload Documentation
+      uses: actions/upload-artifact@v2
+      with:
+        name: documentation
+        path: doc/ford_site
+        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 }}/ford_site/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:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: gh-pages
+        folder: doc/ford_site

doc/ford-front-matter.md

@@ -0,0 +1,28 @@
+project: fenvelopes
+summary: Calculation of phase envelops using Equations of State
+project_github: https://github.com/fedebenelli/fenvelopes
+author: Federico Benelli
+author_description: PhD student with focus on reservoir PVT simulation.
+author_email: [email protected]
+github: https://github.com/fedebenelli
+src_dir: ../src
+exclude_dir: ../test ../doc
+output_dir: ../doc/ford_site
+preprocessor: gfortran -E
+display: public
+         protected
+         private
+source: false
+proc_internals: true
+sort: permission-alpha
+docmark_alt: -|
+docmark: |
+predocmark_alt: *
+print_creation_date: true
+creation_date: %Y-%m-%d %H:%M %z
+md_extensions: markdown.extensions.toc
+               markdown.extensions.smarty
+graph: true
+license: MIT
+
+{!../README.md!}