Skip to content

Commit

Permalink
[mod] use FORD6 on GitHub Actions to deploy docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ShinobuAmasaki committed Dec 22, 2024
1 parent 6d8a942 commit c79f304
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/workflows/ford6.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: FORD6

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:
documentation:
runs-on: ${{ matrix.os }}
permissions:
contents: write
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
python-version: [3.12]

steps:
- name: Checkout Code
uses: actions/checkout@v3
with:
submodules: recursive

- name: Install Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version}}

- name: Setup Graphviz
uses: ts-graphviz/setup-graphviz@v1

- name: Install FORD6
if: contains ( matrix.os, 'ubuntu')
run: |
python -m pip install --upgrade pip
pip install 'FORD==6.2.5'
if [ -f requirements.txt ]; then pip install -r requirement.txt; fi
- name: Build FORD Documentation
run: ford ./gen-ford.yml

- name: Deploy Documentation
uses: JamesIves/github-pages-deploy-action@v4.4.3
with:
branch: gh-pages
folder: doc


16 changes: 16 additions & 0 deletions gen-ford.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
src_dir: ./src
output_dir: ./doc
page_dir: ./doc-src/pages
project: Libpq-Fortran
summary: Access PostgreSQL via Modern Fortran.
author: Amasaki Shinobu
author_pic: https://shinobuamasaki.github.io/img/shinobu.png
github: https://github.com/ShinobuAmasaki
twitter: https://twitter.com/amasaki203
website: https://shinobuamasaki.github.io
favicon: doc-src/ford/favicon.ico
css: doc-src/ford/common.css
graph: false
license: MIT

{!doc-src/readme.md!}

0 comments on commit c79f304

Please sign in to comment.