Merge pull request #2 from algebraic-solving/docu

fixes documentation build process

Author: ederc

docs/make.jl

@@ -1,13 +1,7 @@
-using msolve_jll
-using Nemo
-using LinearAlgebra
 using AlgebraicSolving
 using Documenter
 
-#= push!(LOAD_PATH, "../src") =#
-
-include("../src/imports.jl")
-include("../src/exports.jl")
+push!(LOAD_PATH, "../src")
 
 DocMeta.setdocmeta!(AlgebraicSolving, :DocTestSetup, :(using AlgebraicSolving); recursive=true)
 
@@ -19,7 +13,7 @@ makedocs(
     modules = [AlgebraicSolving],
     doctest = true,
     clean = true,
-    strict = true,
+    checkdocs = :none,
     sitename = "AlgebraicSolving.jl",
     format = Documenter.HTML(),
     pages = [

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

@@ -1,5 +1,16 @@
 ```@meta
 CurrentModule = AlgebraicSolving
+DocTestSetup = quote
+  using AlgebraicSolving
+end
+```
+
+```@setup algebraicsolving
+using AlgebraicSolving
+```
+
+```@contents
+Pages = ["groebner-bases.md"]
 ```
 
 # Gröbner bases

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

@@ -1,5 +1,16 @@
 ```@meta
 CurrentModule = AlgebraicSolving
+DocTestSetup = quote
+  using AlgebraicSolving
+end
+```
+
+```@setup algebraicsolving
+using AlgebraicSolving
+```
+
+```@contents
+Pages = ["katsura.md"]
 ```
 
 # Examples

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

@@ -1,5 +1,16 @@
 ```@meta
 CurrentModule = AlgebraicSolving
+DocTestSetup = quote
+  using AlgebraicSolving
+end
+```
+
+```@setup algebraicsolving
+using AlgebraicSolving
+```
+
+```@contents
+Pages = ["solvers.md"]
 ```
 
 # Algebraic Systems Solving

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

@@ -1,5 +1,16 @@
 ```@meta
 CurrentModule = AlgebraicSolving
+DocTestSetup = quote
+  using AlgebraicSolving
+end
+```
+
+```@setup algebraicsolving
+using AlgebraicSolving
+```
+
+```@contents
+Pages = ["types.md"]
 ```
 
 # Data Types
@@ -15,7 +26,6 @@ We use [Nemo](https://www.nemocas.org/index.html)'s multivariate polynomial
 ring structures:
 
 ```@repl
-using AlgebraicSolving
 R, (x,y,z) = PolynomialRing(QQ, ["x", "y", "z"], ordering=:degrevlex)
 ```
 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
 over finite fields:
 
 ```@repl
-using AlgebraicSolving
 R, (x,y,z) = PolynomialRing(GF(101), ["x", "y", "z"], ordering=:degrevlex)
 ```
 
@@ -35,7 +44,6 @@ data structures connected to ideals in order to make computational algebra more
 effective:
 
 ```@repl
-using AlgebraicSolving
 R, (x,y,z) = PolynomialRing(QQ, ["x", "y", "z"], ordering=:degrevlex)
 I = Ideal([x+y+1, y*z^2-13*y^2])
 ```

src/algorithms/groebner-bases.jl

@@ -24,8 +24,6 @@ At the moment the underlying algorithm is based on variants of Faugère's F4 Alg
 
 # Examples
 ```jldoctest
-julia> using AlgebraicSolving
-
 julia> R, (x,y,z) = PolynomialRing(GF(101),["x","y","z"], ordering=:degrevlex)
 (Multivariate Polynomial Ring in x, y, z over Galois field with characteristic 101, Nemo.gfp_mpoly[x, y, z])
 
@@ -78,8 +76,6 @@ At the moment the underlying algorithm is based on variants of Faugère's F4 Alg
 
 # Examples
 ```jldoctest
-julia> using AlgebraicSolving
-
 julia> R, (x,y,z) = PolynomialRing(GF(101),["x","y","z"], ordering=:degrevlex)
 (Multivariate Polynomial Ring in x, y, z over Galois field with characteristic 101, Nemo.gfp_mpoly[x, y, z])
 

src/algorithms/solvers.jl

@@ -213,8 +213,6 @@ is greater then zero an empty array is returned.
 
 # Examples
 ```jldoctest
-julia> using AlgebraicSolving
-
 julia> R,(x1,x2,x3) = PolynomialRing(QQ, ["x1","x2","x3"])
 (Multivariate Polynomial Ring in x1, x2, x3 over Rational Field, Nemo.fmpq_mpoly[x1, x2, x3])
 
@@ -268,8 +266,6 @@ is greater then zero an empty array is returned.
 
 # Examples
 ```jldoctest
-julia> using AlgebraicSolving
-
 julia> R,(x1,x2,x3) = PolynomialRing(QQ, ["x1","x2","x3"])
 (Multivariate Polynomial Ring in x1, x2, x3 over Rational Field, Nemo.fmpq_mpoly[x1, x2, x3])
 

src/examples/katsura.jl

@@ -22,8 +22,6 @@ Also note that indices have been shifted to start from 1.
 
 # Example
 ```jldoctest
-julia> using AlgebraicSolving
-
 julia> katsura(2)
 Nemo.fmpq_mpoly[x1 + 2*x2 + 2*x3 - 1, x1^2 + 2*x2^2 + 2*x3^2 - x1, 2*x1*x2 + 2*x2*x3 - x2]
 ```
@@ -47,8 +45,6 @@ Returns the Katsura ideal in the given polynomial ring `R`.
 
 # Example
 ```jldoctest
-julia> using AlgebraicSolving
-
 julia> R, _ = QQ["x", "y", "z"]
 (Multivariate Polynomial Ring in x, y, z over Rational Field, Nemo.fmpq_mpoly[x, y, z])