Skip to content

Commit 18886cd

Browse files
zozihazoziha
authored
Merge pull request #25 from zoziha/ford
Add FORD gh-pages for fftpack
2 parents 8c5f089 + e48167a commit 18886cd

File tree

8 files changed

+70
-50
lines changed

8 files changed

+70
-50
lines changed

‎.github/workflows/doc-deployment.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: doc-deployment
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build-and-deploy:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v2
10+
- uses: actions/setup-python@v1
11+
with:
12+
python-version: '3.x'
13+
14+
- name: Install dependencies
15+
run: pip install -v ford==6.1.5
16+
17+
- name: Build Documentation
18+
run: ford API-doc-FORD-file.md
19+
20+
- uses: JamesIves/[email protected]
21+
if: github.event_name == 'push' && github.repository == 'fortran-lang/fftpack' && ( startsWith( github.ref, 'refs/tags/' ) || github.ref == 'refs/heads/main' )
22+
with:
23+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
24+
BRANCH: gh-pages
25+
FOLDER: API-doc
26+
CLEAN: true

‎.github/workflows/fpm.yml

+5-3
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,15 @@ jobs:
4545
- name: Install fpm
4646
uses: fortran-lang/setup-fpm@v3
4747
with:
48-
github-token: ${{ secrets.GITHUB_TOKEN }}
48+
fpm-version: 'v0.5.0'
4949

5050
- name: Build fftpack
5151
run: |
5252
gfortran --version
53-
fpm build --flag "-O2"
53+
fpm build
54+
5455
- name: Run tests
5556
run: |
5657
gfortran --version
57-
fpm test --flag "-O2"
58+
fpm test
59+

‎API-doc-FORD-file.md

+14-40
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
project: fftpack
3-
summary: A opensource package fftpack v4.0.0 for (modern) Fortran
2+
project: Fortran-lang/fftpack
3+
summary: A modernized, opensource package fftpack for (modern) Fortran
44
src_dir: src/
55
output_dir: API-doc
66
page_dir: doc/
@@ -16,20 +16,27 @@ graph_maxdepth: 5
1616
coloured_edges: true
1717
sort: permission-alpha
1818
extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html
19-
iso_c_binding:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fC_005fBINDING.html#ISO_005fC_005fBINDING
2019
print_creation_date: true
2120
creation_date: %Y-%m-%d %H:%M %z
2221
project_github: https://github.com/fortran-lang/fftpack
22+
project_download: https://github.com/fortran-lang/fftpack/archive/HEAD.zip
23+
project_website: https://fortran-lang.github.io/fftpack/
24+
favicon: doc/media/favicon.ico
2325
license: by-sa
24-
author: Paul N. Swarztrauber & fftpack contributors
25-
github: https://github.com/fortran-lang/fftpack
26+
author: Paul N. Swarztrauber &
27+
fortran-lang/fftpack contributors
28+
author_pic: https://fortran-lang.org/assets/img/fortran_logo_512x512.png
29+
author_email: [email protected]
30+
github: https://github.com/fortran-lang
31+
twitter: https://twitter.com/fortranlang
32+
website: https://fortran-lang.org
2633
dbg: true
2734
parallel: 4
2835
---
2936

3037
[TOC]
3138

32-
@warning This API documentation for the fortran-lang/fftpack v4.0.0 is a work in progress.
39+
@warning This API documentation for the Fortran-lang/fftpack is a work in progress.
3340

3441
Fortran FFTPACK API Documentation
3542
=================================
@@ -41,37 +48,4 @@ The documentation for comment markup in source code, running [FORD] and the [FOR
4148
[FORD wiki]: https://github.com/Fortran-FOSS-Programmers/ford/wiki
4249
[FORD project file]: https://github.com/fortran-lang/fftpack/blob/HEAD/API-doc-FORD-file.md
4350

44-
A package of fortran subprograms for the fast fourier transform of periodic and other symmetric sequences.
45-
46-
## Getting started
47-
### Get the code
48-
```bash
49-
git clone https://github.com/fortran-lang/fftpack.git
50-
cd fftpack
51-
```
52-
53-
### Build with [fortran-lang/fpm](https://github.com/fortran-lang/fpm)
54-
Fortran Package Manager (fpm) is a great package manager and build system for Fortran.
55-
You can build using provided `fpm.toml`:
56-
```bash
57-
fpm build --flag "-O2"
58-
fpm test --flag "-O2" --list
59-
fpm test --flag "-O2" <test_name, see `fpm.toml` or list>
60-
```
61-
To use `fftpack` within your `fpm` project, add the following to your `fpm.toml` file:
62-
```toml
63-
[dependencies]
64-
fftpack = { git="https://github.com/fortran-lang/fftpack.git" }
65-
```
66-
67-
## Build with Make
68-
Alternatively, you can build using provided `Makefile`:
69-
```bash
70-
make
71-
```
72-
73-
## Links
74-
[netlib/dfftpack1.0(fftpack4.0)](http://www.netlib.org/fftpack/)
75-
[Documents of fft routines in GNU/gsl based on `netlib/fftpack`](https://www.gnu.org/software/gsl/doc/html/fft.html#)
76-
[Documents of scipy.fftpack](https://docs.scipy.org/doc/scipy/reference/fftpack.html)
77-
[NACR/FFTPACK 5.1](https://www2.cisl.ucar.edu/resources/legacy/fft5)
51+
{!README.md!}

‎README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# FFTPACK
22

3-
[![Actions Status](https://github.com/fortran-lang/fftpack/workflows/fpm/badge.svg)](https://github.com/fortran-lang/fftpack/actions)
43

54
A package of fortran subprograms for the fast fourier transform of periodic and other symmetric sequences.
65

6+
[![Actions Status](https://github.com/fortran-lang/fftpack/workflows/fpm/badge.svg)](https://github.com/fortran-lang/fftpack/actions)
7+
[![Actions Status](https://github.com/fortran-lang/fftpack/workflows/doc-deployment/badge.svg)](https://github.com/fortran-lang/fftpack/actions)
8+
79
## Getting started
810
### Get the code
911
```bash
@@ -32,7 +34,7 @@ make
3234
```
3335

3436
## Links
35-
[netlib/dfftpack1.0(fftpack4.0)](http://www.netlib.org/fftpack/)
36-
[Documents of fft routines in GNU/gsl based on `netlib/fftpack`](https://www.gnu.org/software/gsl/doc/html/fft.html#)
37-
[Documents of scipy.fftpack](https://docs.scipy.org/doc/scipy/reference/fftpack.html)
38-
[NACR/FFTPACK 5.1](https://www2.cisl.ucar.edu/resources/legacy/fft5)
37+
- [netlib/dfftpack1.0(fftpack4.0)](http://www.netlib.org/fftpack/)
38+
- [Documents of fft routines in GNU/gsl based on `netlib/fftpack`](https://www.gnu.org/software/gsl/doc/html/fft.html#)
39+
- [Documents of scipy.fftpack](https://docs.scipy.org/doc/scipy/reference/fftpack.html)
40+
- [NACR/FFTPACK 5.1](https://www2.cisl.ucar.edu/resources/legacy/fft5)

‎doc/media/favicon.ico

16.6 KB
Binary file not shown.

‎doc/specs/fftpack.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: FFTPACK
33
---
44

5-
# The `fftpack` module
5+
# The `fftpack` Module
66

77
[TOC]
88

‎doc/specs/fftpack_kind.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: FFTPACK Kind
3+
---
4+
5+
# The `fftpack_kind` Module
6+
7+
[TOC]
8+
9+
## Introduction
10+
11+
The `fftpack_kind` module provides kind parameters for FFTs.
12+
13+
## Constants provided by `fftpack_kind`
14+
15+
`rk`: **Double precision real kind parameter**. Provides real kind parameter for floating point numbers with a minimal precision of 15 significant digits.

‎doc/specs/index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ title: Specifications (specs)
88

99
## Experimental Features & Modules
1010

11-
- [fftpack](./fftpack.html) - fftpack module.
11+
- [fftpack](./fftpack.html) - fftpack module.
12+
- [fftpack_kind](./fftpack_kind.html) - fftpack_kind module.
1213

1314
## Released/Stable Features & Modules
1415

0 commit comments

Comments
 (0)