Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adapt docs to new block syntax (Documenter.jl), and update them (deri…
…vative, integrate)
- Loading branch information
Luis Benet
committed
May 23, 2016
1 parent
d67eddb
commit 46881a4
Showing
5 changed files
with
220 additions
and
205 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,13 @@ | ||
using Documenter, TaylorSeries | ||
|
||
makedocs( | ||
# modules = TaylorSeries, | ||
modules = Module[TaylorSeries], | ||
clean = false, | ||
doctest = false, | ||
) | ||
|
||
deploydocs( | ||
deps = Deps.pip("pygments", "mkdocs", "mkdocs-bootstrap", "python-markdown-math"), | ||
deps = Deps.pip("pygments", "mkdocs", "mkdocs-cinder", "python-markdown-math"), | ||
repo = "github.com/JuliaDiff/TaylorSeries.jl.git", | ||
julia = "release", | ||
osname = "osx", | ||
) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,42 @@ | ||
{meta} | ||
CurrentModule = TaylorSeries | ||
|
||
# Library | ||
|
||
--- | ||
|
||
```@meta | ||
CurrentModule = TaylorSeries | ||
``` | ||
|
||
## Types | ||
|
||
{docs} | ||
TaylorSeries.Taylor1 | ||
TaylorSeries.HomogeneousPolynomial | ||
TaylorSeries.TaylorN | ||
TaylorSeries.ParamsTaylorN | ||
```@docs | ||
Taylor1 | ||
HomogeneousPolynomial | ||
TaylorN | ||
ParamsTaylorN | ||
``` | ||
|
||
## Functions and methods | ||
|
||
{docs} | ||
TaylorSeries.taylor1_variable() | ||
TaylorSeries.diffTaylor() | ||
TaylorSeries.integTaylor() | ||
TaylorSeries.deriv() | ||
TaylorSeries.evaluate() | ||
|
||
TaylorSeries.taylorN_variable() | ||
TaylorSeries.set_variables() | ||
TaylorSeries.show_params_TaylorN() | ||
TaylorSeries.get_coeff() | ||
|
||
## Internal use | ||
|
||
{docs} | ||
TaylorSeries.generate_tables | ||
TaylorSeries.coeff_table | ||
TaylorSeries.index_table | ||
TaylorSeries.size_table | ||
TaylorSeries.pos_table | ||
```@docs | ||
taylor1_variable | ||
taylorN_variable | ||
set_variables | ||
show_params_TaylorN | ||
get_coeff | ||
``` | ||
|
||
```@docs | ||
evaluate | ||
derivative | ||
integrate | ||
gradient | ||
jacobian | ||
hessian | ||
``` | ||
|
||
## Internals | ||
|
||
```@docs | ||
generate_tables | ||
mulHomogCoef | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.