Skip to content

Commit 1b89cd5

Browse files
committed
created linalg documentation
1 parent cf212ff commit 1b89cd5

File tree

5 files changed

+70
-2
lines changed

5 files changed

+70
-2
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22
*.jl.*.cov
33
*.jl.mem
44
deps/deps.jl
5+
docs/build/
6+
docs/site/

.travis.yml

+3
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,6 @@ after_success:
3333
- julia -e 'cd(Pkg.dir("ReduceLinAlg")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
3434
# push coverage results to Codecov
3535
- julia -e 'cd(Pkg.dir("ReduceLinAlg")); Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())'
36+
# update docs
37+
- julia -e 'Pkg.add("Documenter")'
38+
- julia -e 'cd(Pkg.dir("ReduceLinAlg")); include(joinpath("docs", "make.jl"))'

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@
1111
[![Build status](https://ci.appveyor.com/api/projects/status/e239kk217a0lb92w?svg=true)](https://ci.appveyor.com/project/chakravala/reducelinalg-jl)
1212
[![Coverage Status](https://coveralls.io/repos/JuliaReducePkg/ReduceLinAlg.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/JuliaReducePkg/ReduceLinAlg.jl?branch=master)
1313
[![codecov.io](http://codecov.io/github/JuliaReducePkg/ReduceLinAlg.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaReducePkg/ReduceLinAlg.jl?branch=master)
14+
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaReducePkg.github.io/ReduceLinAlg.jl/stable)
15+
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaReducePkg.github.io/ReduceLinAlg.jl/latest)
1416
[![Join the chat at gitter](https://badges.gitter.im/Reduce-jl/Lobby.svg)](https://gitter.im/Reduce-jl/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
1517

1618
Upstream REDUCE package by Matt Rebbeck.
1719

18-
This Julia package relies on [Reduce.jl](https://github.com/chakravala/Reduce.jl) paser generator by dispatching methods from the "linalg" package.
20+
This Julia package relies on the [Reduce.jl](https://github.com/chakravala/Reduce.jl) parser generator, Julia docs ([stable](https://chakravala.github.io/Reduce.jl/stable) / [latest](https://chakravala.github.io/Reduce.jl/latest)).
1921

20-
Meta-package [ReduceAlgebra.jl](https://github.com/JuliaReducePkg/ReduceAlgebra.jl), upstream docs ([LINALG](http://www.reduce-algebra.com/manual/manualse127.html) / [pdf](http://www.reduce-algebra.com/manual/contributed/linalg.pdf)), Julia docs (none yet)
22+
Meta-package [ReduceAlgebra.jl](https://github.com/JuliaReducePkg/ReduceAlgebra.jl), upstream docs ([LINALG](http://www.reduce-algebra.com/manual/manualse127.html) / [pdf](http://www.reduce-algebra.com/manual/contributed/linalg.pdf)), Julia docs ([stable](https://JuliaReducePkg.github.io/ReduceLinAlg.jl/stable) / [latest](https://JuliaReducePkg.github.io/ReduceLinAlg.jl/latest))

docs/make.jl

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# This file is part of ReduceLinAlg.jl. It is licensed under the MIT license
2+
# Copyright (C) 2018 Michael Reed
3+
4+
using Documenter, ReduceLinAlg
5+
6+
makedocs(
7+
# options
8+
modules = [ReduceLinAlg],
9+
doctest = false,
10+
format = :html,
11+
sitename = "ReduceLinAlg.jl",
12+
authors = "Michael Reed",
13+
pages = Any[
14+
"User's Manual" => "index.md",
15+
]
16+
)
17+
18+
deploydocs(
19+
target = "build",
20+
repo = "github.com/JuliaReducePkg/ReduceLinAlg.jl.git",
21+
branch = "gh-pages",
22+
latest = "master",
23+
osname = "linux",
24+
julia = "0.6",
25+
deps = nothing,
26+
make = nothing,
27+
)

docs/src/index.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# ReduceLinAlg.jl
2+
3+
**LINALG: Linear algebra package**
4+
*A selection of functions that are useful in the world of linear algebra*
5+
6+
This Julia package relies on the [Reduce.jl](https://github.com/chakravala/Reduce.jl) parser generator, Julia docs ([stable](https://chakravala.github.io/Reduce.jl/stable) / [latest](https://chakravala.github.io/Reduce.jl/latest)).
7+
8+
Meta-package [ReduceAlgebra.jl](https://github.com/JuliaReducePkg/ReduceAlgebra.jl), upstream docs ([LINALG](http://www.reduce-algebra.com/manual/manualse127.html) / [pdf](http://www.reduce-algebra.com/manual/contributed/linalg.pdf)), Julia docs ([stable](https://JuliaReducePkg.github.io/ReduceLinAlg.jl/stable) / [latest](https://JuliaReducePkg.github.io/ReduceLinAlg.jl/latest))
9+
10+
```@contents
11+
```
12+
13+
```@index
14+
```
15+
16+
## 16.37 LINALG: Linear algebra package
17+
18+
This package provides a selection of functions that are useful in the world of linear algebra.
19+
20+
Author: Matt Rebbeck.
21+
22+
### 16.37.1 Introduction
23+
24+
This package provides a selection of functions that are useful in the world of linear algebra. These functions are described alphabetically in subsection 16.37.3 and are labelled 16.37.3.1 to 16.37.3.53. They can be classified into four sections(n.b: the numbers after the dots signify the function label in section 16.37.3).
25+
26+
Contributions to this package have been made by Walter Tietze (ZIB).
27+
28+
## Library
29+
30+
```@docs
31+
ReduceLinAlg.hessian
32+
ReduceLinAlg.mat_jacobian
33+
ReduceLinAlg.jordan_block
34+
```

0 commit comments

Comments
 (0)