Cleanup docs and fix #139 by documenting createtable (#197)

Author: quinnj

.travis.yml

@@ -1,45 +1,23 @@
-before_install:
-  - cd ../..
-  - mv $TRAVIS_REPO_SLUG _old
-  - git config --global core.autocrlf false
-  - git clone --depth=50 _old $TRAVIS_REPO_SLUG
-  - cd $TRAVIS_REPO_SLUG
-
+# Documentation: http://docs.travis-ci.com/user/languages/julia/
 language: julia
-
-sudo: false
-
 os:
   - linux
   - osx
   - windows
-
 arch:
   - x64
   - x86
-
 julia:
   - 1.0
   - 1.3
   - nightly
-
-env:
-  - JULIA_PROJECT="@."
-
 matrix:
+  allow_failures:
+    - julia: nightly
+  fast_finish: true
   exclude:
     - os: osx
       arch: x86
-  allow_failures:
-  - julia: nightly
-
-notifications:
-  email: false
-
-after_success:
-   - julia -e 'ENV["TRAVIS_JULIA_VERSION"] == "1.3" && ENV["TRAVIS_OS_NAME"] != "linux" && exit(); using Pkg; Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())'
-
-jobs:
   include:
     - stage: "Documentation"
       julia: 1.3
@@ -48,3 +26,7 @@ jobs:
         - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate(); Pkg.build("SQLite")'
         - julia --project=docs/ docs/make.jl
       after_success: skip
+notifications:
+  email: false
+after_success:
+   - julia -e 'ENV["TRAVIS_JULIA_VERSION"] == "1.3" && ENV["TRAVIS_OS_NAME"] != "linux" && exit(); using Pkg; Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())'

docs/.documenter.enc

@@ -0,0 +1,93 @@
+# This file is machine-generated - editing it directly is not advised
+
+[[Base64]]
+uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
+
+[[Dates]]
+deps = ["Printf"]
+uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
+
+[[Distributed]]
+deps = ["Random", "Serialization", "Sockets"]
+uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"
+
+[[DocStringExtensions]]
+deps = ["LibGit2", "Markdown", "Pkg", "Test"]
+git-tree-sha1 = "88bb0edb352b16608036faadcc071adda068582a"
+uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+version = "0.8.1"
+
+[[Documenter]]
+deps = ["Base64", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
+git-tree-sha1 = "d45c163c7a3ae293c15361acc52882c0f853f97c"
+uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+version = "0.23.4"
+
+[[InteractiveUtils]]
+deps = ["Markdown"]
+uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
+
+[[JSON]]
+deps = ["Dates", "Mmap", "Parsers", "Unicode"]
+git-tree-sha1 = "b34d7cef7b337321e97d22242c3c2b91f476748e"
+uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+version = "0.21.0"
+
+[[LibGit2]]
+deps = ["Printf"]
+uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
+
+[[Libdl]]
+uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
+
+[[Logging]]
+uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
+
+[[Markdown]]
+deps = ["Base64"]
+uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
+
+[[Mmap]]
+uuid = "a63ad114-7e13-5084-954f-fe012c677804"
+
+[[Parsers]]
+deps = ["Dates", "Test"]
+git-tree-sha1 = "c56ecb484f286639f161e712b8311f5ab77e8d32"
+uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
+version = "0.3.8"
+
+[[Pkg]]
+deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"]
+uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+
+[[Printf]]
+deps = ["Unicode"]
+uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+
+[[REPL]]
+deps = ["InteractiveUtils", "Markdown", "Sockets"]
+uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
+
+[[Random]]
+deps = ["Serialization"]
+uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+
+[[SHA]]
+uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
+
+[[Serialization]]
+uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
+
+[[Sockets]]
+uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
+
+[[Test]]
+deps = ["Distributed", "InteractiveUtils", "Logging", "Random"]
+uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[[UUIDs]]
+deps = ["Random", "SHA"]
+uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
+
+[[Unicode]]
+uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"

docs/Manifest.toml

@@ -1,6 +1,2 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-SQLite = "0aa819cd-b072-5ff4-a722-6bc24af294d9"
-
-[compat]
-Documenter = "~0.22"

docs/Project.toml

@@ -1,12 +1,17 @@
 using Documenter, SQLite
 
-makedocs(
-    modules = [SQLite],
-    sitename = "SQLite.jl",
-    pages = ["Home" => "index.md"]
+makedocs(;
+    modules=[SQLite],
+    format=Documenter.HTML(),
+    pages=[
+        "Home" => "index.md",
+    ],
+    repo="https://github.com/JuliaDatabases/SQLite.jl/blob/{commit}{path}#L{line}",
+    sitename="SQLite.jl",
+    authors="Jacob Quinn",
+    assets=String[],
 )
 
-deploydocs(
-    repo = "github.com/JuliaDatabases/SQLite.jl.git",
-    target = "build",
+deploydocs(;
+    repo="github.com/JuliaDatabases/SQLite.jl",
 )

docs/make.jl

@@ -16,6 +16,7 @@ SQLite.DB
 SQLite.Stmt
 SQLite.bind!
 SQLite.execute!
+SQLite.createtable!
 SQLite.drop!
 SQLite.dropindex!
 SQLite.createindex!

docs/mkdocs.yml

@@ -116,7 +116,15 @@ function Query(db::DB, sql::AbstractString; values=[], stricttypes::Bool=true, n
     return Query(stmt, Ref(status), header, types, Dict(x=>i for (i, x) in enumerate(header)))
 end
 
-# as a sink
+"""
+    SQLite.createtable!(db::SQLite.DB, table_name, schema::Tables.Schema; temp=false, ifnotexists=true)
+
+Create a table in `db` with name `table_name`, according to `schema`, which is a set of column names and types, constructed like `Tables.Schema(names, types)`
+where `names` can be a vector or tuple of String/Symbol column names, and `types` is a vector or tuple of sqlite-compatible types (`Int`, `Float64`, `String`, or unions of `Missing`).
+
+If `temp=true`, the table will be created temporarily, which means it will be deleted when the `db` is closed.
+If `ifnotexists=true`, no error will be thrown if the table already exists.
+"""
 function createtable!(db::DB, nm::AbstractString, ::Tables.Schema{names, types}; temp::Bool=false, ifnotexists::Bool=true) where {names, types}
     temp = temp ? "TEMP" : ""
     ifnotexists = ifnotexists ? "IF NOT EXISTS" : ""