add documentation generation stump

JuliaDatabases · Jan 26, 2021 · d9dc9bc · d9dc9bc
1 parent d8dd0b1
commit d9dc9bc
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 0 deletions.
diff --git a/docs/Project.toml 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
@@ -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
@@ -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
+```