Skip to content

Commit 4ded7d6

Browse files
authored
(DOCSP-29159): API Documentation page (#33)
# Pull Request Info [PR Reviewing Guidelines](https://github.com/mongodb/docs-java/blob/master/REVIEWING.md) JIRA - https://jira.mongodb.org/browse/DOCSP-29159 Staging - https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/DOCSP-29159/api-documentation/ ## Self-Review Checklist - [ ] Is this free of any warnings or errors in the RST? - [ ] Did you run a spell-check? - [ ] Did you run a grammar-check? - [ ] Are all the links working?
1 parent b304307 commit 4ded7d6

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ toc_landing_pages = [
1111
"/fundamentals/crud",
1212
"/fundamentals/builders",
1313
"/usage-examples",
14+
"/api-documentation",
1415
]
1516
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
1617

source/api-documentation.txt

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,17 @@ API Documentation
88
:titlesonly:
99
:maxdepth: 1
1010

11-
BSON <{+api+}/apidocs/bson/index.html>
12-
BSON Record Codec <{+api+}/apidocs/bson-record-codec/index.html>
13-
Core <{+api+}/apidocs/mongodb-driver-core/index.html>
14-
Java Driver (modern API) <{+api+}/apidocs/mongodb-driver-sync/index.html>
15-
Java Driver (legacy API) <{+api+}/apidocs/mongodb-driver-legacy/index.html>
16-
11+
BSON kotlinx.serialization <{+api+}/apidocs/bson-kotlinx/index.html>
12+
Core <{+api+}/apidocs/apidocs/mongodb-driver-core/index.html>
13+
Kotlin Coroutine Driver <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/index.html>
14+
Kotlin Sync Driver <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-sync/index.html>
15+
16+
- `BSON kotlinx.serialization <{+api-kotlin+}/apidocs/bson-kotlinx/index.html>`__ -
17+
classes for encoding and decoding between Kotlin data classes and the BSON data
18+
format using :github:`kotlinx.serialization <Kotlin/kotlinx.serialization>`.
19+
- `Core <{+api+}/apidocs/mongodb-driver-core/index.html>`__ - classes that
20+
contain essential driver functionality.
21+
- `Kotlin Coroutine Driver <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/index.html>`__ -
22+
classes for the current driver API using coroutines.
23+
- `Kotlin Sync Driver <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-sync/index.html>`__ -
24+
classes for the current synchronous driver API.

0 commit comments

Comments
 (0)