Merge pull request #199 from jvdp1/docimp

Addition of links for Ford

Author: jvdp1

doc/specs/index.md

@@ -11,24 +11,17 @@ This is and index/directory of the specifications (specs) for each new module/fe
 
 ## Experimental Features & Modules
 
- - [error](./stdlib_experimental_error.html)
-   - Catching and handling errors
- - [IO](./stdlib_experimental_io.html)
-   - Input/output helper & convenience
- - [linalg](./stdlib_experimental_linalg.html)
-   - Linear Algebra
- - [optval](./stdlib_experimental_optval.html)
-   - Fallback value for optional arguments
- - [quadrature](./stdlib_experimental_quadrature.html)
-   - Numerical integration
- - [stats](./stdlib_experimental_stats.html)
-   - Descriptive Statistics
+ - [error](./stdlib_experimental_error.html) - Catching and handling errors
+ - [IO](./stdlib_experimental_io.html) - Input/output helper & convenience
+ - [linalg](./stdlib_experimental_linalg.html) - Linear Algebra
+ - [optval](./stdlib_experimental_optval.html) - Fallback value for optional arguments
+ - [quadrature](./stdlib_experimental_quadrature.html) - Numerical integration
+ - [stats](./stdlib_experimental_stats.html) - Descriptive Statistics
 
 ## Missing specs
 
-@todo
-Populate this section with a list of missing specs and link to their
-[sources on GH](https://github.com/fortran-lang/stdlib/tree/master/src).
+ - [ascii](https://github.com/fortran-lang/stdlib/blob/master/src/stdlib_experimental_ascii.f90)
+ - [kinds](https://github.com/fortran-lang/stdlib/blob/master/src/stdlib_experimental_kinds.f90)
 
 ## Released/Stable Features & Modules
 

doc/specs/stdlib_experimental_error.md

@@ -6,7 +6,7 @@ title: experimental_error
 
 [TOC]
 
-## `[[stdlib_experimental_error(module):check(subroutine)]]` - Checks the value of a logical condition
+## `check` - Checks the value of a logical condition
 
 ### Description
 
@@ -78,7 +78,7 @@ program demo_check3
 end program demo_check3
 ```
 
-## `[[stdlib_experimental_error:error_stop]]` - aborts the program
+## `error_stop` - aborts the program
 
 ### Description
 

doc/specs/stdlib_experimental_io.md

@@ -13,7 +13,7 @@ Loads a rank-2 `array` from a text file.
 
 ### Syntax
 
-`call loadtxt(filename, array)`
+`call [[stdlib_experimental_io(module):loadtxt(interface)]](filename, array)`
 
 ### Arguments
 
@@ -45,7 +45,7 @@ Returns the unit number of a file opened to read, to write, or to read and write
 
 ### Syntax
 
-`u = open(filename [, mode] [, iostat])`
+`u = [[stdlib_experimental_io(module):open(function)]](filename [, mode] [, iostat])`
 
 ### Arguments
 
@@ -97,7 +97,7 @@ Saves a rank-2 `array` into a text file.
 
 ### Syntax
 
-`call savetxt(filename, array)`
+`call [[stdlib_experimental_io(module):savetxt(interface)]](filename, array)`
 
 ### Arguments
 

doc/specs/stdlib_experimental_linalg.md

@@ -14,7 +14,7 @@ Create a diagonal array or extract the diagonal elements of an array
 
 ### Syntax
 
-`d = diag(a [, k])`
+`d = [[stdlib_experimental_linalg(module):diag(interface)]](a [, k])`
 
 ### Arguments
 
@@ -99,7 +99,7 @@ Construct the identity matrix
 
 ## Syntax
 
-`I = eye(n)`
+`I = [[stdlib_experimental_linalg(module):eye(function)]](n)`
 
 ### Arguments
 
@@ -136,7 +136,7 @@ Trace of a matrix (rank-2 array)
 
 ### Syntax
 
-`result = trace(A)`
+`result = [stdlib_experimental_linalg(module):trace(interface)](A)`
 
 ### Arguments
 

doc/specs/stdlib_experimental_optval.md

@@ -16,7 +16,7 @@ This function is intended to be called in a procedure with one or more `optional
 
 ### Syntax
 
-`result = optval(x, default)`
+`result = [[stdlib_experimental_optval(module):optval(interface)]](x, default)`
 
 ### Arguments
 

doc/specs/stdlib_experimental_quadrature.md

@@ -14,9 +14,9 @@ Returns the trapezoidal rule integral of an array `y` representing discrete samp
 
 ### Syntax
 
-`result = trapz(y, x)`
+`result = [[stdlib_experimental_quadrature(module):trapz(interface)]](y, x)`
 
-`result = trapz(y, dx)`
+`result = [[stdlib_experimental_quadrature(module):trapz(interface)]](y, dx)`
 
 ### Arguments
 
@@ -44,7 +44,7 @@ program demo_trapz
 ! 22.0
     print *, trapz(y, 0.5) 
 ! 11.0
-end program
+end program demo_trapz
 ```
 
 ## `trapz_weights` - trapezoidal rule weights for given abscissas
@@ -55,7 +55,7 @@ Given an array of abscissas `x`, computes the array of weights `w` such that if
 
 ### Syntax
 
-`result = trapz_weights(x)`
+`result = [[stdlib_experimental_quadrature(module):trapz_weights(interface)]](x)`
 
 ### Arguments
 
@@ -79,7 +79,7 @@ program demo_trapz_weights
     w = trapz_weight(x)
     print *, dot_product(w, y)
 ! 22.0
-end program
+end program demo_trapz_weights
 
 ```
 

doc/specs/stdlib_experimental_stats.md

@@ -25,7 +25,7 @@ The scaling can be changed with the logical argument `corrected`. If `corrected`
 
 ### Syntax
 
-`result = cov(array, dim [, mask [, corrected]])`
+`result = [[stdlib_experimental_stats(module):cov(interface)]](array, dim [, mask [, corrected]])`
 
 ### Arguments
 
@@ -70,9 +70,9 @@ Returns the mean of all the elements of `array`, or of the elements of `array` a
 
 ### Syntax
 
-`result = mean(array [, mask])`
+`result = [[stdlib_experimental_stats(module):mean(interface)]](array [, mask])`
 
-`result = mean(array, dim [, mask])`
+`result = [[stdlib_experimental_stats(module):mean(interface)]](array, dim [, mask])`
 
 ### Arguments
 
@@ -131,9 +131,9 @@ The _k_-th order moment about `center` is defined as :
 
 ### Syntax
 
-`result = moment(array, order [, center [, mask]])`
+`result = [[stdlib_experimental_stats(module):moment(interface)]](array, order [, center [, mask]])`
 
-`result = moment(array, order, dim [, center [, mask]])`
+`result = [[stdlib_experimental_stats(module):moment(interface)]](array, order, dim [, center [, mask]])`
 
 ### Arguments
 
@@ -192,9 +192,9 @@ The use of the term `n-1` for scaling is called Bessel 's correction. The scalin
 
 ### Syntax
 
-`result = var(array [, mask [, corrected]])`
+`result = [[stdlib_experimental_stats(module):var(interface)]](array [, mask [, corrected]])`
 
-`result = var(array, dim [, mask [, corrected]])`
+`result = [[stdlib_experimental_stats(module):var(interface)]](array, dim [, mask [, corrected]])`
 
 ### Arguments
 

src/stdlib_experimental_error.f90

@@ -1,17 +1,15 @@
 module stdlib_experimental_error
-    !! Provide support for catching and handling errors ([spec](../page/specs/stdlib_experimental_error.html))
-    !!
-    !! __Read the [specification here](../page/specs/stdlib_experimental_error.html).__
+    !! Provides support for catching and handling errors
+    !! ([Specification](../page/specs/stdlib_experimental_error.html))
 use, intrinsic :: iso_fortran_env, only: stderr => error_unit
 use stdlib_experimental_optval, only: optval
 implicit none
 private
 
 interface ! f{08,18}estop.f90
     module subroutine error_stop(msg, code)
-        !! Provides a call to `error stop` and allows the user to specify a code and message.
-        !!
-        !! __Read the [specification here](..//page/specs/stdlib_experimental_error.html#description_1).__
+        !! Provides a call to `error stop` and allows the user to specify a code and message
+        !! ([Specification](..//page/specs/stdlib_experimental_error.html#description_1))
         character(*), intent(in) :: msg
         integer, intent(in), optional :: code
     end subroutine error_stop
@@ -22,9 +20,8 @@ end subroutine error_stop
 contains
 
 subroutine check(condition, msg, code, warn)
-    !! Checks the value of a logical condition. ([spec](../page/specs/stdlib_experimental_error.html#description))
-    !!
-    !! __Read the [specification here](../page/specs/stdlib_experimental_error.html#description).__
+    !! Checks the value of a logical condition
+    !! ([Specification](../page/specs/stdlib_experimental_error.html#description))
     !!
     !!##### Behavior
     !!