Skip to content

Commit cf70fa9

Browse files
authored
preliminary docs config (#23)
1 parent e356f94 commit cf70fa9

File tree

4 files changed

+50
-0
lines changed

4 files changed

+50
-0
lines changed

docs/.gitignore

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

docs/make.jl

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
using Documenter, GraphicalModelLearning
2+
3+
makedocs(
4+
modules = [GraphicalModelLearning],
5+
format = :html,
6+
sitename = "GraphicalModelLearning",
7+
authors = "Carleton Coffrin, Andrey Y. Lokhov, Sidhant Misra, Marc Vuffray, and contributors.",
8+
pages = [
9+
"Home" => "index.md",
10+
"Library" => "library.md"
11+
]
12+
)
13+
14+
deploydocs(
15+
deps = nothing,
16+
make = nothing,
17+
target = "build",
18+
repo = "github.com/lanl-ansi/GraphicalModelLearning.jl.git",
19+
julia = "0.6"
20+
)

docs/src/index.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# GraphicalModelLearning.jl Documentation
2+
3+
```@meta
4+
CurrentModule = GraphicalModelLearning
5+
```
6+
7+
## Overview
8+
9+
GraphicalModelLearning.jl is a Julia package containing algorithms for learning graphical models.
10+
11+
## Installation and Testing
12+
13+
To install the package use,
14+
15+
```julia
16+
Pkg.add("GraphicalModelLearning")
17+
```
18+
19+
To test that the package is working correctly run,
20+
21+
```julia
22+
Pkg.test("GraphicalModelLearning")
23+
```

docs/src/library.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# GraphicalModelLearning.jl Library
2+
3+
```@autodocs
4+
Modules = [GraphicalModelLearning]
5+
```

0 commit comments

Comments
 (0)