Skip to content

Commit 9c42249

Browse files
committed
link docs in README.md, call deploydocs
1 parent 64559ae commit 9c42249

File tree

5 files changed

+13
-2
lines changed

5 files changed

+13
-2
lines changed

.travis.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ julia:
99
notifications:
1010
email: false
1111
branches:
12-
only: # Only kick off CI for master and potential merges to master from within PRs
12+
only:
1313
- master
14+
- /^v[0-9]+\.[0-9]+\.[0-9]+$/ # version tags for Documenter.jl, see # 298
1415
matrix:
1516
allow_failures:
1617
- julia: nightly
@@ -23,3 +24,5 @@ after_success:
2324
- if [ $TRAVIS_JULIA_VERSION = "0.6" ] && [ $TRAVIS_OS_NAME = "linux" ]; then
2425
julia -e 'cd(Pkg.dir("StaticArrays")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder()); Codecov.submit(Codecov.process_folder())';
2526
fi
27+
- julia -e 'Pkg.add("Documenter")'
28+
- julia -e 'cd(Pkg.dir("StaticArrays")); include(joinpath("docs", "make.jl"))'

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
[![Build status](https://ci.appveyor.com/api/projects/status/xabgh1yhsjxlp30d?svg=true)](https://ci.appveyor.com/project/JuliaArrays/staticarrays-jl)
99
[![Coverage Status](https://coveralls.io/repos/github/JuliaArrays/StaticArrays.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaArrays/StaticArrays.jl?branch=master)
1010
[![codecov.io](http://codecov.io/github/JuliaArrays/StaticArrays.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaArrays/StaticArrays.jl?branch=master)
11+
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaArrays.github.io/StaticArrays.jl/latest)
12+
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaArrays.github.io/StaticArrays.jl/stable)
1113

1214
**StaticArrays** provides a framework for implementing statically sized arrays
1315
in Julia (≥ 0.5), using the abstract type `StaticArray{Size,T,N} <: AbstractArray{T,N}`.
@@ -22,6 +24,7 @@ Mutable versions `MVector`, `MMatrix` and `MArray` are also exported, as well
2224
as `SizedArray` for annotating standard `Array`s with static size information.
2325
Further, the abstract `FieldVector` can be used to make fast `StaticVector`s
2426
out of any uniform Julia "struct".
27+
Full documentation can be found [here](https://JuliaArrays.github.io/StaticArrays.jl/stable/).
2528

2629
## Speed
2730

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
build
2+
site

docs/make.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,7 @@ makedocs(
1010
"Quick Start" => "pages/quickstart.md",
1111
],
1212
)
13+
14+
deploydocs(
15+
repo = "github.com/JuliaArrays/StaticArrays.jl",
16+
)

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ The package also provides some concrete static array types: [`SVector`](@ref), [
1212
and [`SArray`](@ref), which may be used as-is (or else embedded in your own type).
1313
Mutable versions [`MVector`](@ref), [`MMatrix`](@ref) and [`MArray`](@ref) are also exported, as well
1414
as [`SizedArray`](@ref) for annotating standard `Array`s with static size information.
15-
Further, the abstract [`FieldVector`](@ref) can be used to make fast static vectors`s
15+
Further, the abstract [`FieldVector`](@ref) can be used to make fast static vectors
1616
out of any uniform Julia "struct".

0 commit comments

Comments
 (0)