Skip to content

Commit 5d019f7

Browse files
authored
Merge pull request #3 from ederc/docu
Docu fixes
2 parents b54d72d + 27795c2 commit 5d019f7

File tree

5 files changed

+46
-11
lines changed

5 files changed

+46
-11
lines changed

docs/make.jl

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
1-
using msolve_jll
2-
using Nemo
3-
using LinearAlgebra
41
using AlgebraicSolving
52
using Documenter
63

7-
#= push!(LOAD_PATH, "../src") =#
8-
9-
include("../src/imports.jl")
10-
include("../src/exports.jl")
4+
push!(LOAD_PATH, "../src")
115

126
DocMeta.setdocmeta!(AlgebraicSolving, :DocTestSetup, :(using AlgebraicSolving); recursive=true)
137

@@ -19,7 +13,7 @@ makedocs(
1913
modules = [AlgebraicSolving],
2014
doctest = true,
2115
clean = true,
22-
strict = true,
16+
checkdocs = :none,
2317
sitename = "AlgebraicSolving.jl",
2418
format = Documenter.HTML(),
2519
pages = [

docs/src/2-groebner-bases.md renamed to docs/src/groebner-bases.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
```@meta
22
CurrentModule = AlgebraicSolving
3+
DocTestSetup = quote
4+
using AlgebraicSolving
5+
end
6+
```
7+
8+
```@setup algebraicsolving
9+
using AlgebraicSolving
10+
```
11+
12+
```@contents
13+
Pages = ["groebner-bases.md"]
314
```
415

516
# Gröbner bases

docs/src/4-katsura.md renamed to docs/src/katsura.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
```@meta
22
CurrentModule = AlgebraicSolving
3+
DocTestSetup = quote
4+
using AlgebraicSolving
5+
end
6+
```
7+
8+
```@setup algebraicsolving
9+
using AlgebraicSolving
10+
```
11+
12+
```@contents
13+
Pages = ["katsura.md"]
314
```
415

516
# Examples

docs/src/3-solvers.md renamed to docs/src/solvers.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
```@meta
22
CurrentModule = AlgebraicSolving
3+
DocTestSetup = quote
4+
using AlgebraicSolving
5+
end
6+
```
7+
8+
```@setup algebraicsolving
9+
using AlgebraicSolving
10+
```
11+
12+
```@contents
13+
Pages = ["solvers.md"]
314
```
415

516
# Algebraic Systems Solving

docs/src/1-types.md renamed to docs/src/types.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
```@meta
22
CurrentModule = AlgebraicSolving
3+
DocTestSetup = quote
4+
using AlgebraicSolving
5+
end
6+
```
7+
8+
```@setup algebraicsolving
9+
using AlgebraicSolving
10+
```
11+
12+
```@contents
13+
Pages = ["types.md"]
314
```
415

516
# Data Types
@@ -15,7 +26,6 @@ We use [Nemo](https://www.nemocas.org/index.html)'s multivariate polynomial
1526
ring structures:
1627

1728
```@repl
18-
using AlgebraicSolving
1929
R, (x,y,z) = PolynomialRing(QQ, ["x", "y", "z"], ordering=:degrevlex)
2030
```
2131
The above example defines a multivariate polynomial ring in three variables `x`,
@@ -24,7 +34,6 @@ for printing polynomials in the following. One can also define polynomial rings
2434
over finite fields:
2535

2636
```@repl
27-
using AlgebraicSolving
2837
R, (x,y,z) = PolynomialRing(GF(101), ["x", "y", "z"], ordering=:degrevlex)
2938
```
3039

@@ -35,7 +44,6 @@ data structures connected to ideals in order to make computational algebra more
3544
effective:
3645

3746
```@repl
38-
using AlgebraicSolving
3947
R, (x,y,z) = PolynomialRing(QQ, ["x", "y", "z"], ordering=:degrevlex)
4048
I = Ideal([x+y+1, y*z^2-13*y^2])
4149
```

0 commit comments

Comments
 (0)