From d9dc9bcaeda0f03918ce2bd45099a0ec179c9a33 Mon Sep 17 00:00:00 2001 From: Alexey Stukalov Date: Tue, 26 Jan 2021 18:45:02 +0100 Subject: [PATCH] add documentation generation stump --- docs/Project.toml | 2 ++ docs/make.jl | 17 +++++++++++++++++ docs/src/index.md | 26 ++++++++++++++++++++++++++ 3 files changed, 45 insertions(+) create mode 100644 docs/Project.toml create mode 100644 docs/make.jl create mode 100644 docs/src/index.md diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..dfa65cd --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,2 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..7d6a89f --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,17 @@ +using Documenter, DBInterface + +makedocs(; + modules=[DBInterface], + format=Documenter.HTML(), + pages=[ + "Home" => "index.md", + ], + repo="https://github.com/JuliaDatabases/DBInterface.jl/blob/{commit}{path}#L{line}", + sitename="DBInterface.jl", + authors="Jacob Quinn", + assets=String[], +) + +deploydocs(; + repo="github.com/JuliaDatabases/DBInterface.jl", +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..a110fab --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,26 @@ +# DBInterface.jl Documentation + +```@contents +``` +*DBInterface.jl* provides interface definitions to allow common database operations to be implemented consistently +across various database packages. + +## Functions +```@docs +DBInterface.connect +DBInterface.prepare +DBInterface.@prepare +DBInterface.execute +DBInterface.executemany +DBInterface.executemultiple +DBInterface.close! +DBInterface.lastrowid +``` + +## Types + +```@docs +DBInterface.Connection +DBInterface.Statement +DBInterface.Cursor +```