Skip to content

Commit

Permalink
updates to ford docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobwilliams committed Jan 5, 2024
1 parent 619c8a9 commit deea5d7
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ jobs:
files: build/coverage/coverage.info

- name: Build documentation
run: ford ./bspline-fortran.md
run: ford ./ford.md

- name: Deploy Documentation
if: github.ref == 'refs/heads/master'
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Multidimensional B-Spline Interpolation of Data on a Regular Grid.

## Status

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

## Documentation

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`).
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`).

## License

Expand Down
5 changes: 1 addition & 4 deletions bspline-fortran.md → ford.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
project: bspline-fortran
project_dir: ./src
src_dir: ./src
output_dir: ./doc
media_dir: ./media
project_github: https://github.com/jacobwilliams/bspline-fortran
Expand All @@ -15,9 +15,6 @@ display: public
private
source: true
graph: true
exclude: pyplot_module.f90
test.f90
exclude_dir: ./src/tests
extra_mods: pyplot_module:https://github.com/jacobwilliams/pyplot-fortran

### Brief description
Expand Down
6 changes: 4 additions & 2 deletions src/bspline_sub_module.f90
Original file line number Diff line number Diff line change
Expand Up @@ -2633,8 +2633,10 @@ pure subroutine dbtpcf(x,n,fcn,ldf,nf,t,k,bcoef,work,iflag)
real(wp),dimension(:),intent(in) :: t
real(wp),dimension(nf,n),intent(out) :: bcoef
real(wp),dimension(*),intent(out) :: work !! work array of size >= `2*k*(n+1)`
integer(ip),intent(out) :: iflag !! 0: no errors
!! 301: n should be >0
integer(ip),intent(out) :: iflag !! status flag:
!!
!! * 0: no errors
!! * 301: n should be >0

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

Expand Down

0 comments on commit deea5d7

Please sign in to comment.