Merge pull request #3 from PeterLuschny/master

AddSignaturesToDocStrings

Author: PeterLuschny

Project.toml

@@ -1,26 +1,14 @@
 name = "Sequences"
 uuid = "b4b868b0-69a7-11e9-2db0-173b4e8e576c"
-authors = ["OLMS <seq@olms.onl>"]
 version = "0.1.0"
 
 [deps]
-AbstractAlgebra = "c3fe647b-3220-5bb0-a1ea-a7954cac585d"
-Atom = "c52e3926-4ff0-5f6e-af25-54175e0327b1"
-BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
-Gumbo = "708ec375-b3d6-5a57-a7ce-8257bf98657a"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
-IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a"
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 IterTools = "c8e1da08-722c-5040-9ed9-7db0dc04731e"
-Juno = "e5e0dc1b-0480-54bc-9374-aad01c23163d"
-MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 Nemo = "2edaba10-b0f1-5616-af89-8c11ac63239a"
-Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
-Primes = "27ebfcd6-29c5-5fa9-bf4b-fb8fc14df3ae"
-StringBuilders = "db12335b-fddc-5e1b-b0ee-42071d21ae50"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"

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()