addsigs

Author: PeterLuschny

docs/src/modules.md

@@ -1,3 +1,3 @@
 # Modules
 
-[Abundant](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Abundant.jl)   🔶  [AndreNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/AndreNumbers.jl)   🔶  [BellNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/BellNumbers.jl)   🔶  [BernoulliNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/BernoulliNumbers.jl)   🔶  [BinaryInteger](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/BinaryInteger.jl)   🔶  [BinaryQF](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/BinaryQF.jl)   🔶  [CarmichaelNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/CarmichaelNumbers.jl)   🔶  [ClausenNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/ClausenNumbers.jl)   🔶  [CombinationsIterator](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/CombinationsIterator.jl)   🔶  [Compositions](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Compositions.jl)   🔶  [Counts](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Counts.jl)   🔶  [DedekindEta](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/DedekindEta.jl)   🔶  [Deleham](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Deleham.jl)   🔶  [Fibonacci](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Fibonacci.jl)   🔶  [FigurativeNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/FigurativeNumbers.jl)   🔶  [GaussFactorialRecords](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/GaussFactorialRecords.jl)   🔶  [GeneralizedBinomial](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/GeneralizedBinomial.jl)   🔶  [HighlyAbundant](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/HighlyAbundant.jl)   🔶  [Hyper1F1](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Hyper1F1.jl)   🔶  [JacobiTheta](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/JacobiTheta.jl)   🔶  [Kolakoski](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Kolakoski.jl)   🔶  [NarayanaCows](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/NarayanaCows.jl)   🔶  [NumberTheory](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/NumberTheory.jl)   🔶  [OEISUtils](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/OEISUtils.jl)   🔶  [OrthoPolynomials](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/OrthoPolynomials.jl)   🔶  [Partitions](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Partitions.jl)   🔶  [PrimesIterator](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/PrimesIterator.jl)   🔶  [PrimeSwingFactorial](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/PrimeSwingFactorial.jl)   🔶  [Products](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Products.jl)   🔶  [QueensProblems](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/QueensProblems.jl)   🔶  [RecordSearch](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/RecordSearch.jl)   🔶  [RiordanSquares](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/RiordanSquares.jl)   🔶  [SelfConvolutive](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/SelfConvolutive.jl)   🔶  [SeqUtils](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/SeqUtils.jl)   🔶  [SeriesExpansion](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/SeriesExpansion.jl)   🔶  [StirlingLahNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/StirlingLahNumbers.jl)   🔶  [SwingFactorial](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/SwingFactorial.jl)   🔶  [Triangles](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Triangles.jl)   🔶  [UlamNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/UlamNumbers.jl)   🔶  [ZumkellerNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/ZumkellerNumbers.jl)   🔶  
+[Abundant](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Abundant.jl)   🔶  [AndreNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/AndreNumbers.jl)   🔶  [BellNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/BellNumbers.jl)   🔶  [BernoulliNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/BernoulliNumbers.jl)   🔶  [BinaryInteger](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/BinaryInteger.jl)   🔶  [BinaryQF](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/BinaryQF.jl)   🔶  [CarmichaelNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/CarmichaelNumbers.jl)   🔶  [ClausenNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/ClausenNumbers.jl)   🔶  [CombinationsIterator](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/CombinationsIterator.jl)   🔶  [Compositions](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Compositions.jl)   🔶  [Counts](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Counts.jl)   🔶  [DedekindEta](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/DedekindEta.jl)   🔶  [Deleham](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Deleham.jl)   🔶  [Fibonacci](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Fibonacci.jl)   🔶  [FigurativeNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/FigurativeNumbers.jl)   🔶  [GaussFactorialRecords](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/GaussFactorialRecords.jl)   🔶  [GeneralizedBinomial](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/GeneralizedBinomial.jl)   🔶  [HighlyAbundant](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/HighlyAbundant.jl)   🔶  [Hyper1F1](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Hyper1F1.jl)   🔶  [JacobiTheta](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/JacobiTheta.jl)   🔶  [Kolakoski](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Kolakoski.jl)   🔶  [NarayanaCows](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/NarayanaCows.jl)   🔶  [NumberTheory](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/NumberTheory.jl)   🔶  [OEISUtils](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/OEISUtils.jl)   🔶  [OrthoPolynomials](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/OrthoPolynomials.jl)   🔶  [Partitions](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Partitions.jl)   🔶  [PrimesIterator](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/PrimesIterator.jl)   🔶  [PrimeSwingFactorial](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/PrimeSwingFactorial.jl)   🔶  [Products](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Products.jl)   🔶  [QueensProblems](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/QueensProblems.jl)   🔶  [RecordSearch](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/RecordSearch.jl)   🔶  [RiordanSquares](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/RiordanSquares.jl)   🔶  [SelfConvolutive](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/SelfConvolutive.jl)   🔶  [SeqUtils](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/SeqUtils.jl)   🔶  [SeriesExpansion](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/SeriesExpansion.jl)   🔶  [StirlingLahNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/StirlingLahNumbers.jl)   🔶  [SwingFactorial](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/SwingFactorial.jl)   🔶  [S_INDEX](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/S_INDEX.jl)   🔶  [Triangles](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/Triangles.jl)   🔶  [UlamNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/UlamNumbers.jl)   🔶  [ZumkellerNumbers](https://github.com/OpenLibMathSeq/Sequences.jl/blob/master/src/ZumkellerNumbers.jl)   🔶  

src/BuildSequences.jl

@@ -186,13 +186,13 @@ function build_seq(docdefs)
 
     tmp = open("_TEMP.jl", "r")
     sor = open("S_INDEX.jl", "r")
-    target = joinpath(srcdir, "Sequences.jl")
+    target = joinpath(srcdir, "_Sequences.jl")
     olm = open(target, "w")
     header(olm)
     println(olm, "__precompile__()")
 
     println(olm, "module Sequences")
-    println(olm, "using Nemo, IterTools, HTTP")
+    println(olm, "using Nemo, IterTools, HTTP, DocStringExtensions")
 
     for l in eachline(sor, keep=true)
         print(olm, l)
@@ -282,6 +282,11 @@ function build_perf()
     o = open(path, "w")
 
     header(o)
+    println(o, "tstdir = realpath(joinpath(dirname(@__FILE__)))")
+    println(o, "srcdir = joinpath(dirname(tstdir), \"src\")")
+    println(o, "tstdir ∉ LOAD_PATH && push!(LOAD_PATH, tstdir)")
+    println(o, "srcdir ∉ LOAD_PATH && push!(LOAD_PATH, srcdir)")
+
     println(o, "module perftests")
     println(o, "using Sequences, Dates, InteractiveUtils")
 
@@ -377,8 +382,63 @@ function make_modules()
     close(ind)
 end
 
+function nextline(srcfile)
+
+    while !eof(srcfile)
+        n = readline(srcfile)
+        n == "" && continue
+        # startswith(n, "#") && continue
+        return n
+    end
+    return nothing
+end
+
+function addsig(srcfile, docfile)
+
+    while true
+
+        n = nextline(srcfile)
+        n == nothing && return
+        while ! startswith(n, "\"\"\"")
+            println(docfile, n)
+            n = nextline(srcfile)
+            n == nothing && return
+        end
+
+        if startswith(n, "\"\"\"")
+            println(docfile, n)
+            n = nextline(srcfile)
+            n == nothing && return
+            while ! startswith(n, "\"\"\"")
+                println(docfile, n)
+                n = nextline(srcfile)
+                n == nothing && return
+            end
+               
+            println(docfile, "\$(SIGNATURES)")
+            println(docfile, n)
+        end
+    end
+end
+
+function addsignature()
+
+    docdir = realpath(joinpath(dirname(@__FILE__)))
+    pkgdir = dirname(docdir)
+    srcdir = joinpath(pkgdir, "src")
+    srcfile = open(joinpath(srcdir, "_Sequences.jl"), "r")
+    docfile = open(joinpath(docdir, "Sequences.jl"), "w")
+
+    addsig(srcfile, docfile)
+
+    close(srcfile)
+    close(docfile)
+    rm("_Sequences.jl")
+end
+
 function build_all(docdefs=false)
     build_seq(docdefs)
+    addsignature()
 
     build_test()
     build_perf()