SWIFT-854 Add custom docs sections (#46)

Author: kmahar

.jazzy.yml

@@ -0,0 +1,47 @@
+module: SwiftBSON
+author: Neal Beeken, Nellie Spektor, Patrick Freed, and Kaitlin Mahar
+author_url: https://github.com/mongodb/swift-bson
+github_url: https://github.com/mongodb/swift-bson
+theme: fullwidth
+swift_build_tool: spm
+readme: "etc/docs-main.md"
+root_url: https://mongodb.github.io/swift-bson/docs/SwiftBSON/
+documentation: "Guides/*.md"
+
+custom_categories:
+  - name: General Guides
+    children:
+      - BSON-Guide
+      - JSON-Interop
+  - name: BSON Types
+    children:
+      - BSON
+      - BSONType
+      - BSONBinary
+      - BSONCode
+      - BSONCodeWithScope
+      - BSONDBPointer
+      - BSONDecimal128
+      - BSONDocument
+      - BSONObjectID
+      - BSONRegularExpression
+      - BSONSymbol
+      - BSONTimestamp
+  - name: Encoding and Decoding BSON
+    children:
+      - BSONEncoder
+      - BSONDecoder
+      - DataCodingStrategy
+      - DateCodingStrategy
+      - UUIDCodingStrategy
+      - CodingStrategyProvider
+      - BSONCoderOptions
+  - name: Encoding and Decoding Extended JSON
+    children:
+      - ExtendedJSONEncoder
+      - ExtendedJSONDecoder
+  - name: Errors
+    children:
+      - BSONError
+      - BSONErrorProtocol
+

Guides/BSON.md renamed to Guides/BSON-Guide.md

@@ -1,6 +1,7 @@
 import Foundation
 import NIO
 
+/// :nodoc:
 /// Iterator over a `BSONDocument`. This type is not meant to be used directly; please use `Sequence` protocol methods
 /// instead.
 public class BSONDocumentIterator: IteratorProtocol {

Sources/SwiftBSON/BSONDocumentIterator.swift

@@ -14,24 +14,11 @@ version=${1}
 # Ensure version is non-empty
 [ ! -z "${version}" ] || { echo "ERROR: Missing version string"; exit 1; }
 
-jazzy_args=(--clean
-            --author "Neal Beeken, Nellie Spektor, Patrick Freed, and Kaitlin Mahar" 
-            --readme "etc/docs-main.md" 
-            --author_url https://github.com/mongodb/swift-bson 
-            --github_url https://github.com/mongodb/swift-bson 
-            --theme fullwidth 
-            --documentation "Guides/*.md" 
-            --github-file-prefix https://github.com/mongodb/swift-bson/tree/v${version} 
-            --module-version "${version}" 
-            --swift-build-tool spm)
-
-modules=( BSON )
-
-for module in "${modules[@]}"; do
-  args=("${jazzy_args[@]}"  --output "docs-temp/${module}" --module "${module}" 
-        --root-url "https://mongodb.github.io/swift-bson/docs/${module}/")
-  jazzy "${args[@]}"
-done
+jazzy \
+--github-file-prefix https://github.com/mongodb/swift-bson/tree/v${version} \
+--module-version "${version}" \
+--output "docs-temp/SwiftBSON" \
+--config .jazzy.yml
 
 # switch to docs branch to commit and push
 git stash