Skip to content

Commit deea5d7

Browse files
committed
updates to ford docs
1 parent 619c8a9 commit deea5d7

File tree

4 files changed

+8
-9
lines changed

4 files changed

+8
-9
lines changed

.github/workflows/CI.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ jobs:
7676
files: build/coverage/coverage.info
7777

7878
- name: Build documentation
79-
run: ford ./bspline-fortran.md
79+
run: ford ./ford.md
8080

8181
- name: Deploy Documentation
8282
if: github.ref == 'refs/heads/master'

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Multidimensional B-Spline Interpolation of Data on a Regular Grid.
55

66
## Status
7-
7+
[![Language](https://img.shields.io/badge/-Fortran-734f96?logo=fortran&logoColor=white)](https://github.com/topics/fortran)
88
[![GitHub release](https://img.shields.io/github/release/jacobwilliams/bspline-fortran.svg)](https://github.com/jacobwilliams/bspline-fortran/releases/latest)
99
[![Build Status](https://github.com/jacobwilliams/bspline-fortran/actions/workflows/CI.yml/badge.svg)](https://github.com/jacobwilliams/bspline-fortran/actions)
1010
[![codecov](https://codecov.io/gh/jacobwilliams/bspline-fortran/branch/master/graph/badge.svg)](https://codecov.io/gh/jacobwilliams/bspline-fortran)
@@ -184,7 +184,7 @@ However, note that an external BLAS can only be used if the library is compiled
184184

185185
## Documentation
186186

187-
The latest API documentation can be found [here](https://jacobwilliams.github.io/bspline-fortran/). This was generated from the source code using [FORD](https://github.com/Fortran-FOSS-Programmers/ford) (i.e. by running `ford bspline-fortran.md`).
187+
The latest API documentation can be found [here](https://jacobwilliams.github.io/bspline-fortran/). This was generated from the source code using [FORD](https://github.com/Fortran-FOSS-Programmers/ford) (i.e. by running `ford ford.md`).
188188

189189
## License
190190

bspline-fortran.md renamed to ford.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
project: bspline-fortran
2-
project_dir: ./src
2+
src_dir: ./src
33
output_dir: ./doc
44
media_dir: ./media
55
project_github: https://github.com/jacobwilliams/bspline-fortran
@@ -15,9 +15,6 @@ display: public
1515
private
1616
source: true
1717
graph: true
18-
exclude: pyplot_module.f90
19-
test.f90
20-
exclude_dir: ./src/tests
2118
extra_mods: pyplot_module:https://github.com/jacobwilliams/pyplot-fortran
2219

2320
### Brief description

src/bspline_sub_module.f90

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2633,8 +2633,10 @@ pure subroutine dbtpcf(x,n,fcn,ldf,nf,t,k,bcoef,work,iflag)
26332633
real(wp),dimension(:),intent(in) :: t
26342634
real(wp),dimension(nf,n),intent(out) :: bcoef
26352635
real(wp),dimension(*),intent(out) :: work !! work array of size >= `2*k*(n+1)`
2636-
integer(ip),intent(out) :: iflag !! 0: no errors
2637-
!! 301: n should be >0
2636+
integer(ip),intent(out) :: iflag !! status flag:
2637+
!!
2638+
!! * 0: no errors
2639+
!! * 301: n should be >0
26382640

26392641
integer(ip) :: i, j, m1, m2, iq, iw
26402642

0 commit comments

Comments
 (0)