Skip to content

Commit 101d574

Browse files
authored
Reformat docstrings and add Documenter docs (#115)
1 parent 22b395b commit 101d574

File tree

6 files changed

+253
-124
lines changed

6 files changed

+253
-124
lines changed

.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
docs/build/
2+
docs/site/
3+
*.jl.cov
4+
*.jl.*.cov
5+
*.jl.mem

.travis.yml

+1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ notifications:
1212
# - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
1313
# - julia -e 'Pkg.clone(pwd()); Pkg.build("Polynomials"); Pkg.test("Polynomials"; coverage=true)';
1414
after_success:
15+
- julia -e 'cd(Pkg.dir("Polynomials")); Pkg.add("Documenter"); using Documenter; include(joinpath("docs", "make.jl"))';
1516
- julia -e 'cd(Pkg.dir("Polynomials")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())';

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,18 @@
22

33
Basic arithmetic, integration, differentiation, evaluation, and root finding over dense univariate polynomials.
44

5-
[![Build Status](https://travis-ci.org/JuliaMath/Polynomials.jl.svg?branch=master)](https://travis-ci.org/JuliaMath/Polynomials.jl)
6-
[![Coverage Status](https://coveralls.io/repos/github/JuliaMath/Polynomials.jl/badge.svg)](https://coveralls.io/github/JuliaMath/Polynomials.jl)
75
[![Polynomials](http://pkg.julialang.org/badges/Polynomials_0.4.svg)](http://pkg.julialang.org/?pkg=Polynomials)
86
[![Polynomials](http://pkg.julialang.org/badges/Polynomials_0.5.svg)](http://pkg.julialang.org/?pkg=Polynomials)
97
[![Polynomials](http://pkg.julialang.org/badges/Polynomials_0.6.svg)](http://pkg.julialang.org/?pkg=Polynomials)
108

9+
Master branch:
10+
[![Build Status](https://travis-ci.org/JuliaMath/Polynomials.jl.svg?branch=master)](https://travis-ci.org/JuliaMath/Polynomials.jl)
11+
[![Coverage Status](https://coveralls.io/repos/github/JuliaMath/Polynomials.jl/badge.svg)](https://coveralls.io/github/JuliaMath/Polynomials.jl)
12+
13+
Documentation:
14+
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaMath.github.io/Polynomials.jl/stable)
15+
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaMath.github.io/Polynomials.jl/latest)
16+
1117
#### Poly{T<:Number}(a::Vector)
1218

1319
Construct a polynomial from its coefficients, lowest order first.

docs/make.jl

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
using Polynomials, Documenter
2+
3+
makedocs(
4+
modules = [Polynomials],
5+
clean = false,
6+
format = :html,
7+
sitename = "Polynomials.jl",
8+
authors = "Jameson Nash, Keno Fischer, and other contributors",
9+
pages = [
10+
"Manual" => "index.md",
11+
],
12+
)
13+
14+
deploydocs(
15+
repo = "github.com/JuliaMath/Polynomials.jl.git",
16+
target = "build",
17+
deps = nothing,
18+
make = nothing,
19+
)

docs/src/index.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Polynomials.jl
2+
3+
Polynomials.jl is a Julia package that provides basic arithmetic, integration,
4+
differentiation, evaluation, and root finding over dense univariate polynomials.
5+
6+
To install the package, run
7+
8+
```julia
9+
Pkg.add("Polynomials")
10+
```
11+
12+
The package can then be loaded into the current session using
13+
14+
```julia
15+
using Polynomials
16+
```
17+
18+
## Functions
19+
20+
```@meta
21+
CurrentModule = Polynomials
22+
```
23+
24+
```@docs
25+
Poly
26+
poly
27+
degree
28+
coeffs
29+
variable
30+
polyval
31+
polyint
32+
polyder
33+
polyfit
34+
roots
35+
```

0 commit comments

Comments
 (0)