Skip to content

Commit f531967

Browse files
committed
some docu updates
1 parent 5c76be1 commit f531967

File tree

3 files changed

+14
-18
lines changed

3 files changed

+14
-18
lines changed

docs/make.jl

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ using LinearAlgebra
44
using AlgebraicSolving
55
using Documenter
66

7-
push!(LOAD_PATH, "../src")
7+
#= push!(LOAD_PATH, "../src") =#
88

99
include("../src/imports.jl")
1010
include("../src/exports.jl")
@@ -19,18 +19,16 @@ makedocs(
1919
modules = [AlgebraicSolving],
2020
doctest = true,
2121
clean = true,
22+
strict = true,
2223
sitename = "AlgebraicSolving.jl",
23-
format = Documenter.HTML(),
24-
pages = Any[
25-
"Introduction" => "index.md",
26-
"User Guide" => Any[
27-
"Data Types" => "types.md",
28-
"Algorithms" => ["algorithms/groebner-bases.md",
29-
"algorithms/solvers.md"],
30-
"Examples" => "examples/katsura.md"
31-
],
32-
],
33-
strict = true
24+
format = Documenter.HTML(prettyurls = !local_build, collapselevel = 1),
25+
pages = [
26+
"About" => "index.md",
27+
"Data Types" => "types.md",
28+
"Algorithms" => ["algorithms/groebner-bases.md",
29+
"algorithms/solvers.md"],
30+
"Examples" => "examples/katsura.md"
31+
]
3432
)
3533

3634
# Deploy built documentation from Travis.

docs/src/algorithms/solvers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ CurrentModule = AlgebraicSolving
66

77
## Introduction
88

9-
Algebraic Solving allows to solve systems for input generators over finite
9+
AlgebraicSolving allows to solve systems for input generators over finite
1010
fields of characteristic smaller $2^{31}$ and over the rationals.
1111

1212
The underlying engine is provided by msolve.

docs/src/index.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ language, maintained by Christian Eder and Mohab Safey El Din.
55

66
- <https://github.com/algebraic-solving/AlgebraicSolving.jl> (Source code)
77

8-
The features of AlgebraicSolving so far includes algorthms for computing
8+
The features of AlgebraicSolving include algorithms for computing
99
Gröbner bases over finite fields and for computing real solutions.
10+
The main workhorse of AlgebraicSolving is the [msolve
11+
library](https://msolve.lip6.fr/) .
1012

1113
## Installation
1214

@@ -19,7 +21,3 @@ At the Julia prompt simply type
1921
```
2022
julia> using Pkg; Pkg.add("AlgebraicSolving")
2123
```
22-
23-
## Quick start
24-
25-
Here are some examples of using AlgebraicSolving....

0 commit comments

Comments
 (0)