diff --git a/snooty.toml b/snooty.toml index bb4f753e..ed1f8793 100644 --- a/snooty.toml +++ b/snooty.toml @@ -20,7 +20,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" driver = "kotlin" driver-short = "Kotlin driver" driver-long = "MongoDB Kotlin Driver" -version = "5.4" +version = "5.5" full-version = "{+version+}.0" language = "Kotlin" mdb-server = "MongoDB server" @@ -28,8 +28,8 @@ kotlin-docs = "https://kotlinlang.org" package-name-org = "mongodb-org" api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs" -core-api = "{+api-root+}/mongodb-driver-core/com/mongodb" -driver-api = "{+api-root+}/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine" +core-api = "{+api-root+}/driver-core/com/mongodb" +driver-api = "{+api-root+}/driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine" stable-api = "Stable API" mongocrypt-version = "{+full-version+}" snappyVersion = "org.xerial.snappy:snappy-java:1.1.8.4" diff --git a/source/api-documentation.txt b/source/api-documentation.txt index 07daf3bb..e6ae5703 100644 --- a/source/api-documentation.txt +++ b/source/api-documentation.txt @@ -9,22 +9,19 @@ API Documentation :titlesonly: :maxdepth: 1 + {+language+} Coroutine Driver <{+api-root+}/driver-kotlin-coroutine/index.html> BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html> - {+language+} Driver Extensions <{+api-root+}/mongodb-driver-kotlin-extensions/index.html> - Driver Core <{+api-root+}/mongodb-driver-core/index.html> - {+language+} Coroutine Driver <{+api-root+}/mongodb-driver-kotlin-coroutine/index.html> - {+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html> + {+language+} Driver Extensions <{+api-root+}/driver-kotlin-extensions/index.html> + Driver Core <{+api-root+}/driver-core/index.html> +- `{+language+} Coroutine Driver <{+api-root+}/driver-kotlin-coroutine/index.html>`__ - + classes for the current driver API using coroutines. - `BSON kotlinx.serialization <{+api-root+}/bson-kotlinx/index.html>`__ - classes for encoding and decoding between Kotlin data classes and the BSON data format using :github:`kotlinx.serialization `. - `{+language+} Driver Extensions - <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ - + <{+api-root+}/driver-kotlin-extensions/index.html>`__ - classes that extend the core builder classes to support :ref:`data classes `. -- `Driver Core <{+api-root+}/mongodb-driver-core/index.html>`__ - classes that +- `Driver Core <{+api-root+}/driver-core/index.html>`__ - classes that contain essential driver functionality. -- `{+language+} Coroutine Driver <{+api-root+}/mongodb-driver-kotlin-coroutine/index.html>`__ - - classes for the current driver API using coroutines. -- `{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>`__ - - classes for the current synchronous driver API. diff --git a/source/fundamentals/builders/builders-data-classes.txt b/source/fundamentals/builders/builders-data-classes.txt index 7439c186..d562a64e 100644 --- a/source/fundamentals/builders/builders-data-classes.txt +++ b/source/fundamentals/builders/builders-data-classes.txt @@ -246,4 +246,4 @@ API Documentation ----------------- - `{+driver-short+} Extensions - <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ + <{+api-root+}/driver-kotlin-extensions/index.html>`__ diff --git a/source/fundamentals/connection/socks5.txt b/source/fundamentals/connection/socks5.txt index a3813d86..9ab2ee92 100644 --- a/source/fundamentals/connection/socks5.txt +++ b/source/fundamentals/connection/socks5.txt @@ -110,5 +110,6 @@ following API documentation: - `MongoClientSettings.Builder <{+core-api+}/MongoClientSettings.Builder.html>`__ - `SocketSettings.Builder <{+core-api+}/connection/SocketSettings.Builder.html>`__ -- `MongoClient.create() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoClients.html#create(com.mongodb.MongoClientSettings)>`__ -- `ProxySettings.Builder <{+core-api+}/connection/ProxySettings.Builder.html>`__ \ No newline at end of file +- `MongoClient.create() <{+driver-api+}/-mongo-client/-factory/index.html>`__ +- `ProxySettings.Builder + <{+core-api+}/connection/ProxySettings.Builder.html>`__ diff --git a/source/fundamentals/databases-collections.txt b/source/fundamentals/databases-collections.txt index 26e52adf..1be32b8b 100644 --- a/source/fundamentals/databases-collections.txt +++ b/source/fundamentals/databases-collections.txt @@ -171,8 +171,8 @@ Drop a Collection ----------------- You can remove a collection from the database using the -`MongoCollection.drop() -<{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#drop()>`__ method: +`MongoCollection.drop() <{+driver-api+}/-mongo-collection/drop.html>`__ +method: .. literalinclude:: /examples/generated/DatabaseCollectionsTest.snippet.drop-collections.kt :language: kotlin diff --git a/source/index.txt b/source/index.txt index b2f74ecc..70951cdf 100644 --- a/source/index.txt +++ b/source/index.txt @@ -70,7 +70,7 @@ Fundamentals API Documentation ----------------- -The MongoDB Kotlin driver API documentation contains several libraries +The {+driver-short+} API documentation contains several libraries organized by functionality. For detailed information about classes and methods in each library, see the following table for their descriptions and links to the API documentation. @@ -83,17 +83,20 @@ and links to the API documentation. * - Library - Description + * - `Kotlin Coroutine Driver <{+api-root+}/driver-kotlin-coroutine/index.html>`__ + - Coroutine API + * - `BSON <{+api-root+}/bson/index.html>`__ - Base BSON classes * - `BSON Record Codec <{+api-root+}/bson-record-codec/index.html>`__ - Classes that support records - * - `Core <{+api-root+}/mongodb-driver-core/index.html>`__ - - Shared core classes + * - `Driver Extensions <{+api-root+}/driver-kotlin-extensions/index.html>`__ + - Classes that support using data classes with builders - * - `Kotlin Driver <{+api-root+}/mongodb-driver-kotlin-coroutine/index.html>`__ - - API + * - `Core <{+api-root+}/driver-core/index.html>`__ + - Shared core classes between JVM drivers FAQ --- diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt index 251e456e..9708df54 100644 --- a/source/usage-examples/deleteMany.txt +++ b/source/usage-examples/deleteMany.txt @@ -54,4 +54,4 @@ page, see the following API Documentation: - `deleteMany() <{+driver-api+}/-mongo-collection/delete-many.html>`__ - `DeleteResult <{+core-api+}/client/result/DeleteResult.html>`__ -- `drop() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#drop()>`__ +- `drop() <{+driver-api+}/-mongo-collection/drop.html>`__ diff --git a/source/whats-new.txt b/source/whats-new.txt index b85aaa90..d7454dbe 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -107,7 +107,7 @@ improvements, and fixes: - Support for using builders class methods directly with data class properties. To learn more, see the :ref:`kotlin-builders-data-classes` guide. This functionality is supported by the `{+driver-short+} - Extensions package <{+api-root+}/mongodb-driver-kotlin-extensions/index.html>`__ + Extensions package <{+api-root+}/driver-kotlin-extensions/index.html>`__ published with this release. - Implements a *client* bulk write API that allows you to perform write