Merge pull request #12 from cescalara/packaging

Docs w/ Literate.jl

.gitignore

@@ -25,12 +25,14 @@ Manifest.toml
 
 # Jupyter notebooks
 .ipynb_checkpoints
-
-# As using jupytext
 *.ipynb
 
 # Docs
 docs/build/
+docs/src/example.md
+docs/src/testsgns.md
+docs/src/timing.md
+docs/src/splint.md
 
 # Mac OS
 .DS_Store

Project.toml

@@ -12,6 +12,7 @@ julia = "1"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
 [targets]
-test = ["Test"]
+test = ["Test", "Documenter"]

docs/Project.toml

@@ -1,5 +1,7 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 
 [compat]
-Documenter = "0.27"
+Documenter = "0.27"
+Literate = "2"

docs/make.jl

@@ -1,12 +1,28 @@
 push!(LOAD_PATH,"../src/")
 
-using Documenter, QCDNUM
+using Documenter
+using QCDNUM
+using Literate
+
+# Generate examples notebooks
+gen_content_dir = joinpath(@__DIR__, "src")
+
+example_src = joinpath(@__DIR__, "..", "examples", "example.jl")
+testsgns_src = joinpath(@__DIR__, "..", "examples", "testsgns.jl")
+timing_src = joinpath(@__DIR__, "..", "examples", "timing.jl")
+splint_src = joinpath(@__DIR__, "..", "examples", "splint.jl")
+
+Literate.markdown(example_src, gen_content_dir, name="example")
+Literate.markdown(testsgns_src, gen_content_dir, name="testsgns")
+Literate.markdown(timing_src, gen_content_dir, name="timing")
+Literate.markdown(splint_src, gen_content_dir, name="splint")
 
 About = "Introduction" => "index.md"
 
 Installation = "Installation" => "installation.md"
 
-Examples = "Examples" => "examples.md"
+Examples = "Examples" => ["example.md", "testsgns.md",
+                          "timing.md", "splint.md"]
 
 Functions = "Available functions" => "functions.md"