Skip to content

Commit

Permalink
(docs) Added auto deployment of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
14NGiestas committed Nov 28, 2024
1 parent 88d86fb commit ec64fae
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/docs-deployment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: docs-deployment

on: [push]

jobs:
Build:
runs-on: ubuntu-latest

steps:
- name: Checkout 🛎️
uses: actions/[email protected]

- 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/[email protected]
if: github.event_name != 'pull_request'
with:
BRANCH: docs
FOLDER: mfi-fpm
28 changes: 28 additions & 0 deletions ford.md
Original file line number Diff line number Diff line change
@@ -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: [email protected]
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
---

0 comments on commit ec64fae

Please sign in to comment.