Skip to content

Commit c1f9a13

Browse files
authored
Try to fix docs (#38)
1 parent c0489a8 commit c1f9a13

2 files changed

Lines changed: 5 additions & 21 deletions

File tree

.github/workflows/ci.yml

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -48,20 +48,13 @@ jobs:
4848
- uses: codecov/codecov-action@v1
4949
with:
5050
file: lcov.info
51-
docs:
51+
Documenter:
5252
name: Documentation
5353
runs-on: ubuntu-latest
5454
steps:
5555
- uses: actions/checkout@v2
56-
- uses: julia-actions/setup-julia@v1
57-
with:
58-
version: '1'
59-
- run: |
60-
julia --project=docs -e '
61-
using Pkg
62-
Pkg.develop(PackageSpec(path=pwd()))
63-
Pkg.instantiate()'
64-
- run: julia --project=docs docs/make.jl
56+
- uses: julia-actions/julia-buildpkg@latest
57+
- uses: julia-actions/julia-docdeploy@latest
6558
env:
6659
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6760
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

README.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,8 @@ for result in results
5151
end
5252

5353
DBInterface.close!(stmt) # close the prepared statement
54+
DBInterface.close!(conn) # close connection
5455
```
5556

5657
### For Database Package Developers
57-
See the documentation for the following to understand required types and inheritance, as well as functions to overload:
58-
```julia
59-
DBInterface.Connection
60-
DBInterface.connect
61-
DBInterface.close!
62-
DBInterface.Statement
63-
DBInterface.prepare
64-
DBInterface.execute
65-
DBInterface.executemultiple
66-
DBInterface.lastrowid
67-
```
58+
See the [documentation](https://juliadatabases.org/DBInterface.jl/latest/) for expanded details on required interface methods.

0 commit comments

Comments
 (0)