Skip to content

Commit d9dc9bc

Browse files
committed
add documentation generation stump
1 parent d8dd0b1 commit d9dc9bc

3 files changed

Lines changed: 45 additions & 0 deletions

File tree

docs/Project.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/make.jl

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
using Documenter, DBInterface
2+
3+
makedocs(;
4+
modules=[DBInterface],
5+
format=Documenter.HTML(),
6+
pages=[
7+
"Home" => "index.md",
8+
],
9+
repo="https://github.com/JuliaDatabases/DBInterface.jl/blob/{commit}{path}#L{line}",
10+
sitename="DBInterface.jl",
11+
authors="Jacob Quinn",
12+
assets=String[],
13+
)
14+
15+
deploydocs(;
16+
repo="github.com/JuliaDatabases/DBInterface.jl",
17+
)

docs/src/index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# DBInterface.jl Documentation
2+
3+
```@contents
4+
```
5+
*DBInterface.jl* provides interface definitions to allow common database operations to be implemented consistently
6+
across various database packages.
7+
8+
## Functions
9+
```@docs
10+
DBInterface.connect
11+
DBInterface.prepare
12+
DBInterface.@prepare
13+
DBInterface.execute
14+
DBInterface.executemany
15+
DBInterface.executemultiple
16+
DBInterface.close!
17+
DBInterface.lastrowid
18+
```
19+
20+
## Types
21+
22+
```@docs
23+
DBInterface.Connection
24+
DBInterface.Statement
25+
DBInterface.Cursor
26+
```

0 commit comments

Comments
 (0)