Add API Docs (#202)

Author: 0xTim

.github/workflows/api-docs.yml

@@ -1,18 +1,14 @@
 name: deploy-api-docs
 on:
-   push:
-     branches:
-       - main
+  push:
+    branches:
+      - main
 
 jobs:
-  deploy:
-    name: api.vapor.codes
-    runs-on: ubuntu-latest
-    steps:
-    - name: Deploy api-docs
-      uses: appleboy/ssh-action@master
-      with:
-        host: vapor.codes
-        username: vapor
-        key: ${{ secrets.VAPOR_CODES_SSH_KEY }}
-        script: ./github-actions/deploy-api-docs.sh
+  build-and-deploy:
+     uses: vapor/api-docs/.github/workflows/build-and-deploy-docs-workflow.yml@main
+     secrets: inherit
+     with:
+       package_name: fluent-postgres-driver
+       modules: FluentPostgresDriver
+       pathsToInvalidate: /fluentpostgresdriver

.github/workflows/test.yml

@@ -160,3 +160,14 @@ jobs:
         uses: actions/checkout@v3
       - name: Run all tests
         run: swift test
+
+  test-exports:
+    name: Test exports
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out Vapor
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Build
+        run: swift build -Xswiftc -DBUILDING_DOCC

.spi.yml

@@ -1,3 +1,5 @@
 version: 1
 metadata:
-  authors: “Maintained by the Vapor Core Team with hundreds of contributions from the Vapor Community.”
+  authors: "Maintained by the Vapor Core Team with hundreds of contributions from the Vapor Community."
+external_links:
+  documentation: "https://api.vapor.codes/fluentpostgresdriver/documentation/fluentpostgresdriver/"

Sources/FluentPostgresDriver/Docs.docc/index.md

@@ -0,0 +1,3 @@
+# ``FluentPostgresDriver``
+
+FluentPostgresDriver is a package to integrate PostgresNIO and and PostrgresKit with FluentKit to make it easy to use and write database operations in Swift.

Sources/FluentPostgresDriver/Exports.swift

@@ -1,8 +1,17 @@
+#if !BUILDING_DOCC
+
 @_exported import FluentKit
 @_exported import PostgresKit
 
+#else 
+
+import FluentKit
+import PostgresKit
+
+#endif
+
 extension DatabaseID {
     public static var psql: DatabaseID {
         return .init(string: "psql")
     }
-}
+}

Sources/FluentPostgresDriver/FluentPostgresConfiguration.swift

@@ -1,4 +1,7 @@
 import Logging
+import FluentKit
+import NIOCore
+import PostgresKit
 
 extension DatabaseConfigurationFactory {
     public static func postgres(

Sources/FluentPostgresDriver/FluentPostgresDatabase.swift

@@ -1,5 +1,6 @@
 import FluentSQL
 import Logging
+import PostgresKit
 
 struct _FluentPostgresDatabase {
     let database: PostgresDatabase

Sources/FluentPostgresDriver/FluentPostgresDriver.swift

@@ -1,4 +1,6 @@
 import Logging
+import FluentKit
+import PostgresKit
 
 enum FluentPostgresError: Error {
     case invalidURL(String)

Sources/FluentPostgresDriver/PostgresError+Database.swift

@@ -1,4 +1,5 @@
 import FluentSQL
+import PostgresKit
 
 extension PostgresError: DatabaseError {
     public var isSyntaxError: Bool {

Sources/FluentPostgresDriver/PostgresRow+Database.swift

@@ -1,3 +1,6 @@
+import PostgresKit
+import FluentKit
+
 extension PostgresRow {
     internal func databaseOutput(using decoder: PostgresDataDecoder) -> DatabaseOutput {
         _PostgresDatabaseOutput(