Documentation updates (#476)

* Add reference links to functions

* Move DLMF links in overview to paragraphs

In functions_overview.md, Documenter.jl picks up section headers
for permalinks. Move the links to their own paragraphs.

* Add import for installation

* Add DLMF section names to links

Two links to DLMF share the same text, disambiguate
by using the sections they're pointing to.

* Remove redundant latex newline

* Fix indents

* Correct latex sequences

* Add link text to bare urls

* Wrap lines

* Change latex sequence

* Update spacing

* Refactor links to Base

* Mark code syntax

* Add equation/section numbers to DLMF links

The equation number in the anchor text helps more
easily identify links, and can help in navigation.

TODO: do something for the Wikipedia links?

* Fix exponent notation in LaTeX

* Add DOI to reference

* Fix spacing

* Use raw_str for latex containing docstrings

* Fix indent

* Split method docstrings for erf

* Add backticks

* Add doc raw"" for easier LaTeX escaping

* Use subscripts in latex

* Remove redundant \operatorname

Most TeX engines recognize \ln and \log

* Fix backtick and backslash use

* Remove asterisk stars from tex

* Add sections to function list

* Partial revert of 71f7e42

Remove `erf(::Real)` method used for docstring, and add
`erf(::Real, ::Real)` for docs page

* Remove internal function from docs API reference

* Use `\mathrm` for integrating variable in latex

Author: abhro

docs/make.jl

@@ -8,6 +8,8 @@ makedocs(modules=[SpecialFunctions],
          format = Documenter.HTML(; assets = String[]),
          pages=["Home" => "index.md",
                 "Overview" => "functions_overview.md",
-                "Reference" => "functions_list.md"])
+                "Reference" => "functions_list.md"],
+         #warnonly=[:missing_docs],
+        )
 
 deploydocs(repo="github.com/JuliaMath/SpecialFunctions.jl.git")

docs/src/functions_list.md

@@ -4,7 +4,150 @@
 CurrentModule = SpecialFunctions
 ```
 
-```@autodocs
-Modules = [SpecialFunctions]
-Order   = [:module, :type, :function]
+
+## Gamma Function
+
+```@docs
+gamma
+loggamma
+logabsgamma
+loggamma1p
+logfactorial
+digamma
+invdigamma
+trigamma
+polygamma
+gamma_inc
+gamma_inc_inv
+loggammadiv
+gammax
+rgammax
+rgamma1pm1
+gamma_inc_asym
+gamma_inc_cf
+gamma_inc_fsum
+gamma_inc_minimax
+gamma_inc_taylor
+gamma_inc_taylor_x
+gamma_inc_temme
+gamma_inc_temme_1
+gamma_inc_inv_psmall
+gamma_inc_inv_qsmall
+gamma_inc_inv_alarge
+auxgam
+```
+
+### Beta Function
+```@docs
+beta
+logbeta
+logabsbeta
+logabsbinomial
+beta_inc
+beta_inc_inv
+ncbeta
+ncbeta_poisson
+ncbeta_tail
+beta_inc_power_series1
+beta_inc_power_series2
+beta_inc_asymptotic_asymmetric
+beta_inc_asymptotic_symmetric
+beta_inc_power_series
+beta_inc_diff
+beta_inc_cont_fraction
+beta_integrand
+```
+
+### Utilities
+
+```@docs
+chepolsum
+lambdaeta
+stirling_corr
+stirling_error
+esum
+coeff1
+coeff2
+coeff3
+ncF
+```
+
+## Exponential and Trigonometric Integrals
+
+```@docs
+expint
+expinti
+expintx
+sinint
+cosint
+```
+
+## Error Functions, Dawson’s and Fresnel Integrals
+
+```@docs
+erf
+erf(::Real, ::Real)
+erfc
+logerf
+erfcinv
+erfcx
+logerfc
+logerfcx
+erfi
+erfinv
+dawson
+faddeeva
+```
+
+## Airy and Related Functions
+
+```@docs
+airyai
+airyaiprime
+airybi
+airybiprime
+airyaix
+airyaiprimex
+airybix
+airybiprimex
+```
+
+## Bessel Functions
+
+```@docs
+besselj
+besselj0
+besselj1
+besseljx
+sphericalbesselj
+bessely
+bessely0
+bessely1
+besselyx
+sphericalbessely
+besselh
+besselhx
+hankelh1
+hankelh1x
+hankelh2
+hankelh2x
+besseli
+besselix
+besselk
+besselkx
+jinc
+```
+
+## Elliptic Integrals
+
+```@docs
+ellipk
+ellipe
+```
+
+## Zeta and Related Functions
+
+```@docs
+eta
+zeta
 ```

docs/src/functions_overview.md

@@ -15,5 +15,5 @@ The latest version of the package is available for Julia versions 1.3
 and up. To install it, run the following at the Julia REPL:
 
 ```julia
-Pkg.add("SpecialFunctions")
+import Pkg; Pkg.add("SpecialFunctions")
 ```