Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ford documentation: improvements #784

Merged
merged 10 commits into from
Apr 8, 2024
2 changes: 1 addition & 1 deletion .github/workflows/doc-deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:

- name: Install dependencies
run: |
pip install -v ford==6.1.10
pip install -v ford==7.0.5
pip install fypp
python --version
ford --version
Expand Down
4 changes: 3 additions & 1 deletion API-doc-FORD-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ exclude_dir: src/tests
output_dir: API-doc
page_dir: doc
media_dir: doc/media
exclude: src/stdlib_linalg_blas*.fypp
src/stdlib_linalg_lapack*.fypp
fpp_extensions: fypp
preprocess: true
macro: MAXRANK=3
Expand Down Expand Up @@ -36,7 +38,7 @@ favicon: doc/media/favicon.ico
license: by-sa
author: fortran-lang/stdlib contributors
author_pic: https://fortran-lang.org/assets/img/fortran_logo_512x512.png
author_email: fortran-lang@groups.io
email: fortran-lang@groups.io
github: https://github.com/fortran-lang
twitter: https://twitter.com/fortranlang
website: https://fortran-lang.org
Expand Down
2 changes: 1 addition & 1 deletion doc/specs/stdlib_ansi.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Generic interface to turn a style, foreground or background enumerator into an a

#### Syntax

`string = [[stdlib_string_colors(module):to_string(interface)]] (code)`
`string =` [[stdlib_ansi(module):to_string(interface)]] `(code)`

#### Class

Expand Down
4 changes: 2 additions & 2 deletions doc/specs/stdlib_array.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The built-in / intrinsics are usually preferable to `trueloc`, unless the access

#### Syntax

`loc = [[trueloc(function)]] (array[, lbound])`
`loc =` [[trueloc(function)]] `(array[, lbound])`

#### Class

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

#### Syntax

`loc = [[falseloc(function)]] (array[, lbound])`
`loc =` [[falseloc(function)]] `(array[, lbound])`

#### Class

Expand Down
10 changes: 5 additions & 5 deletions doc/specs/stdlib_ascii.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Converts input character variable to all lowercase.

#### Syntax

`res = [[stdlib_ascii(module):to_lower(function)]] (string)`
`res =` [[stdlib_ascii(module):to_lower(function)]] `(string)`

#### Class

Expand Down Expand Up @@ -66,7 +66,7 @@ Converts input character variable to all uppercase.

#### Syntax

`res = [[stdlib_ascii(module):to_upper(function)]] (string)`
`res =` [[stdlib_ascii(module):to_upper(function)]] `(string)`

#### Class

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

#### Syntax

`res = [[stdlib_ascii(module):to_title(function)]] (string)`
`res =` [[stdlib_ascii(module):to_title(function)]] `(string)`

#### Class

Expand Down Expand Up @@ -138,7 +138,7 @@ transformed to lowercase.

#### Syntax

`res = [[stdlib_ascii(module):to_sentence(function)]] (string)`
`res =` [[stdlib_ascii(module):to_sentence(function)]] `(string)`

#### Class

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

#### Syntax

`res = [[stdlib_ascii(module):reverse(function)]] (string)`
`res =` [[stdlib_ascii(module):reverse(function)]] `(string)`

#### Class

Expand Down
Loading
Loading