Skip to content

Commit c79f304

Browse files
[mod] use FORD6 on GitHub Actions to deploy docs.
1 parent 6d8a942 commit c79f304

File tree

2 files changed

+66
-0
lines changed

2 files changed

+66
-0
lines changed

.github/workflows/ford6.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: FORD6
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
pull_request:
7+
branches: [ "main" ]
8+
9+
jobs:
10+
documentation:
11+
runs-on: ${{ matrix.os }}
12+
permissions:
13+
contents: write
14+
strategy:
15+
fail-fast: false
16+
matrix:
17+
os: [ubuntu-latest]
18+
python-version: [3.12]
19+
20+
steps:
21+
- name: Checkout Code
22+
uses: actions/checkout@v3
23+
with:
24+
submodules: recursive
25+
26+
- name: Install Python
27+
uses: actions/setup-python@v4
28+
with:
29+
python-version: ${{ matrix.python-version}}
30+
31+
- name: Setup Graphviz
32+
uses: ts-graphviz/setup-graphviz@v1
33+
34+
- name: Install FORD6
35+
if: contains ( matrix.os, 'ubuntu')
36+
run: |
37+
python -m pip install --upgrade pip
38+
pip install 'FORD==6.2.5'
39+
if [ -f requirements.txt ]; then pip install -r requirement.txt; fi
40+
41+
- name: Build FORD Documentation
42+
run: ford ./gen-ford.yml
43+
44+
- name: Deploy Documentation
45+
uses: JamesIves/[email protected]
46+
with:
47+
branch: gh-pages
48+
folder: doc
49+
50+

gen-ford.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
src_dir: ./src
2+
output_dir: ./doc
3+
page_dir: ./doc-src/pages
4+
project: Libpq-Fortran
5+
summary: Access PostgreSQL via Modern Fortran.
6+
author: Amasaki Shinobu
7+
author_pic: https://shinobuamasaki.github.io/img/shinobu.png
8+
github: https://github.com/ShinobuAmasaki
9+
twitter: https://twitter.com/amasaki203
10+
website: https://shinobuamasaki.github.io
11+
favicon: doc-src/ford/favicon.ico
12+
css: doc-src/ford/common.css
13+
graph: false
14+
license: MIT
15+
16+
{!doc-src/readme.md!}

0 commit comments

Comments
 (0)