Skip to content

Commit 4ed4c52

Browse files
authored
Merge pull request #784 from jvdp1/fix_ford
Ford documentation: improvements
2 parents df45374 + b955c41 commit 4ed4c52

30 files changed

+347
-328
lines changed

.github/workflows/doc-deployment.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222

2323
- name: Install dependencies
2424
run: |
25-
pip install -v ford==6.1.10
25+
pip install -v ford==7.0.5
2626
pip install fypp
2727
python --version
2828
ford --version

API-doc-FORD-file.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ exclude_dir: src/tests
88
output_dir: API-doc
99
page_dir: doc
1010
media_dir: doc/media
11+
exclude: src/stdlib_linalg_lapack.fypp
12+
src/stdlib_linalg_lapack_aux.fypp
13+
src/stdlib_linalg_lapack_c.fypp
14+
src/stdlib_linalg_lapack_d.fypp
15+
src/stdlib_linalg_lapack_q.fypp
16+
src/stdlib_linalg_lapack_s.fypp
17+
src/stdlib_linalg_lapack_w.fypp
18+
src/stdlib_linalg_lapack_z.fypp
1119
fpp_extensions: fypp
1220
preprocess: true
1321
macro: MAXRANK=3
@@ -36,7 +44,7 @@ favicon: doc/media/favicon.ico
3644
license: by-sa
3745
author: fortran-lang/stdlib contributors
3846
author_pic: https://fortran-lang.org/assets/img/fortran_logo_512x512.png
39-
author_email: [email protected]
47+
4048
github: https://github.com/fortran-lang
4149
twitter: https://twitter.com/fortranlang
4250
website: https://fortran-lang.org

doc/specs/stdlib_ansi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Generic interface to turn a style, foreground or background enumerator into an a
194194

195195
#### Syntax
196196

197-
`string = [[stdlib_string_colors(module):to_string(interface)]] (code)`
197+
`string =` [[stdlib_ansi(module):to_string(interface)]] `(code)`
198198

199199
#### Class
200200

doc/specs/stdlib_array.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The built-in / intrinsics are usually preferable to `trueloc`, unless the access
2727

2828
#### Syntax
2929

30-
`loc = [[trueloc(function)]] (array[, lbound])`
30+
`loc =` [[trueloc(function)]] `(array[, lbound])`
3131

3232
#### Class
3333

@@ -64,7 +64,7 @@ The built-in / intrinsics are usually preferable to `falseloc`, unless the acces
6464

6565
#### Syntax
6666

67-
`loc = [[falseloc(function)]] (array[, lbound])`
67+
`loc =` [[falseloc(function)]] `(array[, lbound])`
6868

6969
#### Class
7070

doc/specs/stdlib_ascii.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Converts input character variable to all lowercase.
3434

3535
#### Syntax
3636

37-
`res = [[stdlib_ascii(module):to_lower(function)]] (string)`
37+
`res =` [[stdlib_ascii(module):to_lower(function)]] `(string)`
3838

3939
#### Class
4040

@@ -66,7 +66,7 @@ Converts input character variable to all uppercase.
6666

6767
#### Syntax
6868

69-
`res = [[stdlib_ascii(module):to_upper(function)]] (string)`
69+
`res =` [[stdlib_ascii(module):to_upper(function)]] `(string)`
7070

7171
#### Class
7272

@@ -103,7 +103,7 @@ or numeral present next to either of its 2 ends.
103103

104104
#### Syntax
105105

106-
`res = [[stdlib_ascii(module):to_title(function)]] (string)`
106+
`res =` [[stdlib_ascii(module):to_title(function)]] `(string)`
107107

108108
#### Class
109109

@@ -138,7 +138,7 @@ transformed to lowercase.
138138

139139
#### Syntax
140140

141-
`res = [[stdlib_ascii(module):to_sentence(function)]] (string)`
141+
`res =` [[stdlib_ascii(module):to_sentence(function)]] `(string)`
142142

143143
#### Class
144144

@@ -170,7 +170,7 @@ Reverses the order of all characters in the input character type.
170170

171171
#### Syntax
172172

173-
`res = [[stdlib_ascii(module):reverse(function)]] (string)`
173+
`res =` [[stdlib_ascii(module):reverse(function)]] `(string)`
174174

175175
#### Class
176176

0 commit comments

Comments
 (0)