Skip to content

Commit 8a66869

Browse files
committed
docs(docs): add Documenter.jl docs
1 parent fa5d776 commit 8a66869

File tree

8 files changed

+58
-0
lines changed

8 files changed

+58
-0
lines changed

Diff for: docs/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/build/
2+
/Manifest.toml

Diff for: docs/Project.toml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

Diff for: docs/make.jl

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
push!(LOAD_PATH, "../src/")
2+
3+
using Documenter, TypedMatrices
4+
5+
DocMeta.setdocmeta!(TypedMatrices, :DocTestSetup, :(using TypedMatrices); recursive=true)
6+
7+
format = Documenter.HTML(
8+
collapselevel=1,
9+
)
10+
11+
makedocs(
12+
modules=[TypedMatrices],
13+
sitename="TypedMatrices.jl",
14+
checkdocs=:none,
15+
format=format,
16+
pages=[
17+
"Home" => "index.md",
18+
"Manual" => [
19+
"manual/getting-started.md",
20+
],
21+
"Reference" => [
22+
"reference/types.md",
23+
"reference/interfaces.md",
24+
"reference/matrices.md",
25+
],
26+
]
27+
)

Diff for: docs/src/index.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# TypedMatrices.jl Documentation
2+
3+
Welcome to the documentation for TypedMatrices.jl.
4+
5+
An extensible Julia matrix collection utilizing type system to enhance performance.
6+
7+
Check [Getting Started](@ref) for a quick start.
8+
9+
## Features
10+
11+
- Types of matercies, can be used in algorithm tests or other.
12+
- Optimized matrix operations for these types
13+
- Properties (tags) for matrices.
14+
- Grouping matercies and allow user to define their own types.
15+
- Filtering matrices by properties or groups.

Diff for: docs/src/manual/getting-started.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Getting Started
2+
3+
## Installation
4+
5+
TypedMatrices.jl is a registered package in the Julia package registry. To install it, you can use the Julia package manager. From the Julia REPL, type `]` to enter the Pkg REPL mode and run:
6+
7+
```julia-repl
8+
pkg> add Documenter
9+
```

Diff for: docs/src/reference/interfaces.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Interfaces

Diff for: docs/src/reference/matrices.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Matrices

Diff for: docs/src/reference/types.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Types

0 commit comments

Comments
 (0)