Skip to content

Commit 8f33ad5

Browse files
committed
Update Documenter.
1 parent 932e37c commit 8f33ad5

File tree

5 files changed

+18
-76
lines changed

5 files changed

+18
-76
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SpecialFunctions.jl
22

3-
Special mathematical functions in Julia, including Bessel, Hankel, Airy, error, Dawson, exponential (or sine and cosine) integrals,
3+
Special mathematical functions in Julia, include Bessel, Hankel, Airy, error, Dawson, exponential (or sine and cosine) integrals,
44
eta, zeta, digamma, inverse digamma, trigamma, and polygamma functions.
55
Most of these functions were formerly part of Base in early versions of Julia.
66

docs/Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
33
SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
44

55
[compat]
6-
Documenter = "~0.24"
6+
Documenter = "~0.27"

docs/make.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ using SpecialFunctions, Documenter
33
makedocs(modules=[SpecialFunctions],
44
sitename="SpecialFunctions.jl",
55
authors="Jeff Bezanson, Stefan Karpinski, Viral B. Shah, et al.",
6+
format = Documenter.HTML(; assets = String[]),
67
pages=["Home" => "index.md",
78
"Overview" => "functions_overview.md",
8-
"List" => "functions_list.md"])
9+
"Reference" => "functions_list.md"])
910

1011
deploydocs(repo="github.com/JuliaMath/SpecialFunctions.jl.git")

docs/src/functions_list.md

Lines changed: 3 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -4,70 +4,7 @@
44
CurrentModule = SpecialFunctions
55
```
66

7-
```@docs
8-
SpecialFunctions.erf
9-
SpecialFunctions.erfc
10-
SpecialFunctions.erfcx
11-
SpecialFunctions.logerfc
12-
SpecialFunctions.logerfcx
13-
SpecialFunctions.erfi
14-
SpecialFunctions.faddeeva
15-
SpecialFunctions.dawson
16-
SpecialFunctions.erfinv
17-
SpecialFunctions.erfcinv
18-
SpecialFunctions.expint
19-
SpecialFunctions.expinti
20-
SpecialFunctions.expintx
21-
SpecialFunctions.sinint
22-
SpecialFunctions.cosint
23-
SpecialFunctions.digamma
24-
SpecialFunctions.invdigamma
25-
SpecialFunctions.trigamma
26-
SpecialFunctions.polygamma
27-
SpecialFunctions.airyai
28-
SpecialFunctions.airyaiprime
29-
SpecialFunctions.airyaix
30-
SpecialFunctions.airyaiprimex
31-
SpecialFunctions.airybi
32-
SpecialFunctions.airybiprime
33-
SpecialFunctions.airybix
34-
SpecialFunctions.airybiprimex
35-
SpecialFunctions.besselj0
36-
SpecialFunctions.besselj1
37-
SpecialFunctions.besselj
38-
SpecialFunctions.besseljx
39-
SpecialFunctions.sphericalbesselj
40-
SpecialFunctions.bessely0
41-
SpecialFunctions.bessely1
42-
SpecialFunctions.bessely
43-
SpecialFunctions.besselyx
44-
SpecialFunctions.sphericalbessely
45-
SpecialFunctions.hankelh1
46-
SpecialFunctions.hankelh1x
47-
SpecialFunctions.hankelh2
48-
SpecialFunctions.hankelh2x
49-
SpecialFunctions.besselh
50-
SpecialFunctions.besselhx
51-
SpecialFunctions.besseli
52-
SpecialFunctions.besselix
53-
SpecialFunctions.besselk
54-
SpecialFunctions.besselkx
55-
SpecialFunctions.jinc
56-
SpecialFunctions.ellipk
57-
SpecialFunctions.ellipe
58-
SpecialFunctions.eta
59-
SpecialFunctions.zeta
60-
SpecialFunctions.gamma(::Number)
61-
SpecialFunctions.loggamma(::Number)
62-
SpecialFunctions.logabsgamma
63-
SpecialFunctions.logfactorial
64-
SpecialFunctions.gamma(::Number,::Number)
65-
SpecialFunctions.loggamma(::Number,::Number)
66-
SpecialFunctions.gamma_inc
67-
SpecialFunctions.gamma_inc_inv
68-
SpecialFunctions.beta_inc
69-
SpecialFunctions.beta
70-
SpecialFunctions.logbeta
71-
SpecialFunctions.logabsbeta
72-
SpecialFunctions.logabsbinomial
7+
```@autodocs
8+
Modules = [SpecialFunctions]
9+
Order = [:module, :type, :function]
7310
```

docs/src/index.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1-
# Special Functions
1+
# SpecialFunctions.jl
22

3-
[`SpecialFunctions.jl`](https://github.com/JuliaMath/SpecialFunctions.jl/) provides a comprehensive collection of special functions based on the
4-
[OpenSpecFun](https://github.com/JuliaLang/openspecfun) and [OpenLibm](https://github.com/JuliaLang/openlibm)
5-
libraries.
3+
[`SpecialFunctions.jl`](https://github.com/JuliaMath/SpecialFunctions.jl/)
4+
provides a comprehensive collection of special functions based on the
5+
[OpenSpecFun](https://github.com/JuliaLang/openspecfun) and
6+
[OpenLibm](https://github.com/JuliaLang/openlibm) libraries.
7+
8+
Special mathematical functions in Julia, include Bessel, Hankel,
9+
Airy, error, Dawson, exponential (or sine and cosine) integrals, eta,
10+
zeta, digamma, inverse digamma, trigamma, and polygamma functions.
611

712
## Installation
813

9-
The latest version of the package is available for Julia versions 1.3 and up. To install it, run
14+
The latest version of the package is available for Julia versions 1.3
15+
and up. To install it, run the following at the Julia REPL:
1016

1117
```julia
1218
Pkg.add("SpecialFunctions")
1319
```
14-
15-
from the Julia REPL. Earlier versions of `SpecialFunctions.jl` are available also for Julia v0.5-1.2.

0 commit comments

Comments
 (0)