Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andreasnoack committed Dec 15, 2018
1 parent a56a3ab commit 902a37a
Show file tree
Hide file tree
Showing 8 changed files with 53 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
@@ -0,0 +1,2 @@
Manifest.toml
docs/build/
11 changes: 11 additions & 0 deletions .travis.yml
Expand Up @@ -14,3 +14,14 @@ matrix:

after_success:
- julia -e 'using 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 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
Pkg.instantiate()'
- julia --project=docs/ docs/make.jl
after_success: skip
1 change: 1 addition & 0 deletions README.md
Expand Up @@ -2,6 +2,7 @@
[![Build Status](https://travis-ci.org/JuliaLinearAlgebra/GenericLinearAlgebra.jl.svg?branch=master)](https://travis-ci.org/JuliaLinearAlgebra/GenericLinearAlgebra.jl)
[![Build Status](https://dev.azure.com/andreasnoack/GenericLinearAlgebra/_apis/build/status/andreasnoack.GenericLinearAlgebra.jl?branchName=master)](https://dev.azure.com/andreasnoack/GenericLinearAlgebra/_build/latest?definitionId=2)
[![Coverage Status](https://coveralls.io/repos/github/JuliaLinearAlgebra/GenericLinearAlgebra.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/JuliaLinearAlgebra/GenericLinearAlgebra.jl?branch=master)
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaLinearAlgebra.github.io/GenericLinearAlgebra.jl/stable)

### A fresh approach to numerical linear algebra in Julia

Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
@@ -0,0 +1,2 @@
build/
site/
5 changes: 5 additions & 0 deletions docs/Project.toml
@@ -0,0 +1,5 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

[compat]
Documenter = "~0.21"
15 changes: 15 additions & 0 deletions docs/make.jl
@@ -0,0 +1,15 @@
using Documenter
using GenericLinearAlgebra

makedocs(
sitename = "GenericLinearAlgebra",
format = Documenter.HTML(),
modules = [GenericLinearAlgebra]
)

# Documenter can also automatically deploy documentation to gh-pages.
# See "Hosting Documentation" and deploydocs() in the Documenter manual
# for more information.
deploydocs(
repo = "https://github.com/JuliaLinearAlgebra/GenericLinearAlgebra.jl.git"
)
11 changes: 11 additions & 0 deletions docs/src/index.md
@@ -0,0 +1,11 @@
# GenericLinearAlgebra.jl

Documentation for GenericLinearAlgebra.jl

```@meta
CurrentModule = GenericLinearAlgebra
```

```@docs
svd!
```
6 changes: 6 additions & 0 deletions src/svd.jl
Expand Up @@ -434,6 +434,12 @@ end

# FixMe! The full keyword is redundant for Bidiagonal and should be removed from Base
LinearAlgebra.svd!(B::Bidiagonal{T}; tol = eps(T), full = false, debug = false) where T<:Real = _svd!(B, tol = tol, debug = debug)

"""
svd!
A generic SVD implementation.
"""
function LinearAlgebra.svd!(A::StridedMatrix{T}; tol = eps(real(eltype(A))), full = false, debug = false) where T

m, n = size(A)
Expand Down

0 comments on commit 902a37a

Please sign in to comment.