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

Documentation updates #476

Merged
merged 30 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from 29 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
6599c59
Add reference links to functions
abhro May 29, 2024
4c22459
Move DLMF links in overview to paragraphs
abhro May 29, 2024
7fd2a3d
Add import for installation
abhro May 29, 2024
7f481d9
Add DLMF section names to links
abhro May 29, 2024
62d01fa
Remove redundant latex newline
abhro May 29, 2024
ccad58e
Fix indents
abhro May 29, 2024
6997b79
Correct latex sequences
abhro May 29, 2024
e5ab828
Add link text to bare urls
abhro May 29, 2024
5677bff
Wrap lines
abhro May 29, 2024
c307c27
Change latex sequence
abhro May 29, 2024
3b91248
Update spacing
abhro May 29, 2024
a3e3a7e
Refactor links to Base
abhro May 29, 2024
c4e52b5
Mark code syntax
abhro May 29, 2024
5d5ab3f
Add equation/section numbers to DLMF links
abhro May 30, 2024
ab80d66
Fix exponent notation in LaTeX
abhro May 30, 2024
fb02fc0
Add DOI to reference
abhro May 30, 2024
e26f6d3
Fix spacing
abhro May 30, 2024
7b9c818
Use raw_str for latex containing docstrings
abhro Jun 1, 2024
a5c8858
Fix indent
abhro Jun 1, 2024
71f7e42
Split method docstrings for erf
abhro Jun 1, 2024
11da6be
Add backticks
abhro Jun 1, 2024
6727d68
Add doc raw"" for easier LaTeX escaping
abhro Jul 1, 2024
e72babf
Use subscripts in latex
abhro Jul 1, 2024
991870f
Remove redundant \operatorname
abhro Jul 1, 2024
cc17155
Fix backtick and backslash use
abhro Jul 1, 2024
50576c5
Remove asterisk stars from tex
abhro Jul 1, 2024
5a6856c
Add sections to function list
abhro Jul 1, 2024
e0e6443
Partial revert of 71f7e422
abhro Jul 1, 2024
6af1195
Remove internal function from docs API reference
abhro Jul 1, 2024
db0d3c3
Use `\mathrm` for integrating variable in latex
abhro Jul 1, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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")
149 changes: 146 additions & 3 deletions docs/src/functions_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
164 changes: 91 additions & 73 deletions docs/src/functions_overview.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")
```
Loading
Loading