Skip to content

Commit

Permalink
Add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
blegat committed May 25, 2019
1 parent 19e6d18 commit f61302b
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 5 deletions.
10 changes: 10 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,13 @@ before_script:
- julia -e 'using Pkg; Pkg.add(PackageSpec(url="https://github.com/blegat/SetProg.jl.git", rev="master"))'
after_success:
- julia -e 'import Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(process_folder()); Codecov.submit(process_folder())'

jobs:
include:
- stage: "Documentation"
julia: 1.0
os: linux
script:
- julia --project=docs/ -e 'import Pkg; Pkg.instantiate(); Pkg.develop(Pkg.PackageSpec(path=pwd()))'
- julia --project=docs/ docs/make.jl
after_success: skip
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,8 @@ It also includes utilities for approximation the [Joint Spectral Radius](https:/
## Installation

The package currently requires Julia v1.0, you can download it [here](https://julialang.org/downloads/).
It also needs the latest unreleased versions of JuMP, PolyJuMP and SumOfSquares so once Julia is installed,
launch the REPL an type
Once Julia is installed, simply launch the REPL an type
```julia
] add JuMP#master
] add PolyJuMP#master
] add SumOfSquares#master
] add https://github.com/blegat/SetProg.jl.git
] add https://github.com/blegat/SwitchOnSafety.jl.git
```
Expand Down
6 changes: 6 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
SwitchOnSafety = "ceb7f16a-07bf-5f4a-9354-b68f01b1610f"

[compat]
Documenter = "~0.21"
16 changes: 16 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
using Documenter, SwitchOnSafety

makedocs(
sitename = "SwitchOnSafety",
# See https://github.com/JuliaDocs/Documenter.jl/issues/868
format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
# See https://github.com/JuliaOpt/JuMP.jl/issues/1576
strict = true,
pages = [
"Introduction" => "index.md"
]
)

deploydocs(
repo = "github.com/blegat/SwitchOnSafety.jl.git"
)
6 changes: 6 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Switch On Safety (SOS)

```@docs
soslyap
soslyapbs
```

0 comments on commit f61302b

Please sign in to comment.