From ec64fae38b8df051954f6887dc9a04d5e6a636e4 Mon Sep 17 00:00:00 2001 From: 14NGiestas Date: Thu, 28 Nov 2024 14:35:09 -0300 Subject: [PATCH] (docs) Added auto deployment of docs --- .github/workflows/docs-deployment.yml | 41 +++++++++++++++++++++++++++ ford.md | 28 ++++++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 .github/workflows/docs-deployment.yml create mode 100644 ford.md diff --git a/.github/workflows/docs-deployment.yml b/.github/workflows/docs-deployment.yml new file mode 100644 index 00000000..0a1036fc --- /dev/null +++ b/.github/workflows/docs-deployment.yml @@ -0,0 +1,41 @@ +name: docs-deployment + +on: [push] + +jobs: + Build: + runs-on: ubuntu-latest + + steps: + - name: Checkout 🛎️ + uses: actions/checkout@v2.3.1 + + - name: Set up Python 3.x + uses: actions/setup-python@v1 + with: + python-version: 3.x + + - name: Install fypp + run: pip install --upgrade fypp + + - name: Install ford + run: pip install --upgrade ford + + - name: Generate fpm package 🔧 + run: | + make FYPPFLAGS=-DMFI_EXTENSIONS + mkdir mfi-fpm + cp -R src mfi-fpm + cp -R test mfi-fpm + cp fpm.toml mfi-fpm + cp LICENSE mfi-fpm + find mfi-fpm/src -type f ! -name "*.f90" -delete + find mfi-fpm/test -type f ! -name "*.f90" -delete + ford ford.md + + - name: Deploy docs 🚀 + uses: JamesIves/github-pages-deploy-action@4.1.5 + if: github.event_name != 'pull_request' + with: + BRANCH: docs + FOLDER: mfi-fpm diff --git a/ford.md b/ford.md new file mode 100644 index 00000000..a6fbda28 --- /dev/null +++ b/ford.md @@ -0,0 +1,28 @@ +--- +project: MFI - Modern Fortran Interfaces +src_dir: ./src +output_dir: ./api-reference +project_github: https://github.com/14NGiestas/mfi +project_website: +summary: A collection of modern fortran interfaces for BLAS and LAPACK +author: I. G. Pauli +author_description: +github: https://github.org/14NGiestas +email: iangiestas@usp.br +macro: HAS_DECREMENT +predocmark: > +media_dir: ./media +docmark_alt: # +predocmark_alt: < +display: public + protected + private +source: true +graph: true +search: true +license: by-nc +max_frontpage_items: 4 +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 +--- +