docs/.gitignore

@@ -1,2 +1,3 @@
 build/
 src/examples/*.md
+src/generated

docs/make.jl

@@ -3,30 +3,15 @@ using Literate
 using CondensedMatterSOS
 using Test
 
-const _EXAMPLE_DIR = joinpath(@__DIR__, "..", "examples")
+const EXAMPLES_DIR = joinpath(@__DIR__, "..", "examples")
 const OUTPUT_DIR   = joinpath(@__DIR__, "src/generated")
 
-function link_example(content)
-    edit_url = match(r"EditURL = \"(.+?)\"", content)[1]
-    footer = match(r"^(---\n\n\*This page was generated using)"m, content)[1]
-    content = replace(
-        content, footer => "[View this file on Github]($(edit_url)).\n\n" * footer
-    )
-    return content
-end
+include(joinpath(EXAMPLES_DIR, "run_examples.jl"))
 
-for file in readdir(_EXAMPLE_DIR)
-    if !endswith(file, ".jl")
-        continue
-    end
-    filename = joinpath(_EXAMPLE_DIR, file)
-    # `include` the file to test it before `#src` lines are removed. It is in a
-    # testset to isolate local variables between files.
-    @testset "$(file)" begin
-        include(filename)
-    end
-    Literate.markdown(filename, OUTPUT_DIR)
-    Literate.notebook(filename, OUTPUT_DIR)
+for example in EXAMPLES
+    example_filepath = joinpath(EXAMPLES_DIR, example)
+    Literate.markdown(example_filepath, OUTPUT_DIR)
+    Literate.notebook(example_filepath, OUTPUT_DIR)
 end
 
 makedocs(
@@ -37,13 +22,11 @@ makedocs(
     strict = true,
     pages = [
         "Introduction" => "index.md",
-        "Examples" => map(
-            file -> joinpath(OUTPUT_DIR, file),
-            filter(
-                file -> endswith(file, ".md"),
-                sort(readdir(OUTPUT_DIR)),
-            )
-        )
+        "Examples" => map(EXAMPLES) do jl_file
+            # Need `string` as Documenter fails if `name` is a `SubString{String}`.
+            name = string(split(jl_file, ".")[1])
+            return name => "generated/$name.md"
+        end
     ],
 )
 

examples/all_examples.jl

@@ -0,0 +1,2 @@
+const EXAMPLES = filter(ex -> endswith(ex, ".jl") && ex != "run_examples.jl" && ex != "all_examples.jl",
+                        readdir(@__DIR__))

examples/run_examples.jl

@@ -0,0 +1,9 @@
+using Test
+
+include("all_examples.jl")
+
+@testset "run_examples.jl" begin
+    @testset "$(example)" for example in EXAMPLES
+        include(example)
+    end
+end

src/monom-set.jl

@@ -1,5 +1,5 @@
 """
-    monomials(vars::Vector{CondensedMatterSOS.SpinVariable}, deg::Int64)
+    monomials(vars::Vector{CondensedMatterSOS.SpinVariable}, deg::Int)
 
 This version returns all the monomials of degree deg with all the possible orders
 ```
@@ -9,7 +9,7 @@ E1. (sx[1],sx[2])->[sx[1]*sx[2],sx[2]*sx[1]];
 E2. (sx[1],sy[1])->[sx[1]*sy[1],sy[1]*sx[1]];
 ```
 """
-function monomials_old(vars::Vector{CondensedMatterSOS.SpinVariable}, deg::Int64)
+function monomials(vars::Vector{CondensedMatterSOS.SpinVariable}, deg::Int)
     CC = combinations(vars,deg)
     BB = permutations.(collect(Iterators.take(CC,length(CC))))
     AA = prod.(vcat(map(x->collect(Iterators.take(x,length(x))), vcat(BB...))...))
@@ -52,7 +52,7 @@ function MP.monomials(vars::Vector{SpinVariable}, degs::AbstractVector{Int}, fil
 end
 
 # # using CondensedMatterSOS
-# # function monomials(vars::Vector{CondensedMatterSOS.SpinVariable}, deg::Int64)
+# # function monomials(vars::Vector{CondensedMatterSOS.SpinVariable}, deg::Int)
 # #
 # #
 # # using CondensedMatterSOS

test/runtests.jl

@@ -153,8 +153,8 @@ end
 @testset "monomials" begin
     @test monovec([1, sigmax[1], sigmax[2]]) == [sigmax[1], sigmax[2], 1]
     @test monomials([sigmax[1], sigmax[2]], 0) == [1]
-    @test CMS.monomials_old([sigmax[1], sigmax[2]], 0) == [1]
+    @test CMS.monomials([sigmax[1], sigmax[2]], 0) == [1]
     @test all(monomials([sigmax[1], sigmax[2]], 2) .== [CMS.SpinVariable(sigmax[1].id, i) * CMS.SpinVariable(sigmax[2].id, j) for i in 0:2 for j in 0:2])
-    @test all(CMS.monomials_old([sigmax[1],sigmax[2]],2) .== [sigmax[1]*sigmax[2]])
-    @test all(CMS.monomials_old([sigmax[1],sigmay[1]],2) .== [im*sigmaz[1],-im*sigmaz[1]])
+    @test all(CMS.monomials([sigmax[1],sigmax[2]],2) .== [sigmax[1]*sigmax[2]])
+    @test all(CMS.monomials([sigmax[1],sigmay[1]],2) .== [im*sigmaz[1],-im*sigmaz[1]])
 end