From e6ddaeb7814f6702751c6b512f2a959242b939a2 Mon Sep 17 00:00:00 2001 From: rustagir Date: Wed, 7 May 2025 16:24:02 -0400 Subject: [PATCH 1/2] Update api links for 5.5 link changes --- snooty.toml | 4 ++-- source/api.txt | 12 ++++++------ source/builders/builders-data-classes.txt | 2 +- source/data-formats/codecs.txt | 7 ++++--- source/security/enterprise-auth.txt | 2 +- source/whats-new.txt | 2 +- 6 files changed, 15 insertions(+), 14 deletions(-) diff --git a/snooty.toml b/snooty.toml index 9d13885f..8642f637 100644 --- a/snooty.toml +++ b/snooty.toml @@ -30,8 +30,8 @@ version = "v{+version-number+}" mdb-server = "MongoDB Server" stable-api = "Stable API" api-root = "https://mongodb.github.io/mongo-java-driver/{+version-number+}/apidocs" -driver-api = "{+api-root+}/mongodb-driver-kotlin-sync/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client" -core-api = "{+api-root+}/mongodb-driver-core/com/mongodb" +driver-api = "{+api-root+}/driver-kotlin-sync/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client" +core-api = "{+api-root+}/driver-core/com/mongodb" kotlin-docs = "https://kotlinlang.org" serialization-version = "1.6.0" kotlinx-dt-version = "0.6.1" diff --git a/source/api.txt b/source/api.txt index afced3bb..60030787 100644 --- a/source/api.txt +++ b/source/api.txt @@ -8,19 +8,19 @@ API Documentation :titlesonly: :maxdepth: 1 - {+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html> + {+language+} Sync Driver <{+api-root+}/driver-kotlin-sync/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+} Driver Extensions <{+api-root+}/driver-kotlin-extensions/index.html> + Driver Core <{+api-root+}/driver-core/index.html> -- `{+language+} Sync Driver <{+api-root+}/mongodb-driver-kotlin-sync/index.html>`__ - +- `{+language+} Sync Driver <{+api-root+}/driver-kotlin-sync/index.html>`__ - classes for the current synchronous driver API. - `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. diff --git a/source/builders/builders-data-classes.txt b/source/builders/builders-data-classes.txt index 5f7474cf..120bbc23 100644 --- a/source/builders/builders-data-classes.txt +++ b/source/builders/builders-data-classes.txt @@ -259,4 +259,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/data-formats/codecs.txt b/source/data-formats/codecs.txt index fa6edebf..68e97006 100644 --- a/source/data-formats/codecs.txt +++ b/source/data-formats/codecs.txt @@ -252,7 +252,7 @@ For more information about the classes and interfaces in this section, see the following API documentation: - `CodecProvider <{+api-root+}/bson/org/bson/codecs/configuration/CodecProvider.html>`__ -- `getCodecRegistry() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#getCodecRegistry()>`__ +- `getCodecRegistry() <{+core-api+}/MongoClientSettings.html#getCodecRegistry()>`__ BsonTypeClassMap ~~~~~~~~~~~~~~~~ @@ -386,5 +386,6 @@ retrieves data by using the ``Monolight`` class: For more information about the methods and classes mentioned in this section, see the following API documentation: -- `withCodecRegistry() <{+api-root+}/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#withCodecRegistry(org.bson.codecs.configuration.CodecRegistry)>`__ -- `fromRegistries() <{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistries.html#fromRegistries(org.bson.codecs.configuration.CodecRegistry...)>`__ \ No newline at end of file +- `withCodecRegistry() <{+driver-api+}/-mongo-collection/with-codec-registry.html>`__ +- `fromRegistries() + <{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistries.html#fromRegistries(org.bson.codecs.configuration.CodecRegistry...)>`__ diff --git a/source/security/enterprise-auth.txt b/source/security/enterprise-auth.txt index ecc0d042..b7cab1c6 100644 --- a/source/security/enterprise-auth.txt +++ b/source/security/enterprise-auth.txt @@ -208,7 +208,7 @@ to improve performance. To cache Kerberos tickets by process, you must specify the ``JAVA_SUBJECT_PROVIDER`` mechanism property and provide a - `KerberosSubjectProvider `__ + `KerberosSubjectProvider <{+core-api+}/KerberosSubjectProvider.html>`__ in your ``MongoCredential`` instance. The code to configure the Kotlin driver to cache Kerberos tickets by process should resemble the following: diff --git a/source/whats-new.txt b/source/whats-new.txt index 0a20b37a..be452f04 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -93,7 +93,7 @@ improvements, and fixes: - Support for using builders class methods directly with data class properties. To learn more, see the :ref:`kotlin-sync-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 From 5455785c51f174140a2b23b5562f55f288d17f9a Mon Sep 17 00:00:00 2001 From: rustagir Date: Wed, 7 May 2025 16:24:18 -0400 Subject: [PATCH 2/2] bump version --- snooty.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index 8642f637..f014f333 100644 --- a/snooty.toml +++ b/snooty.toml @@ -24,7 +24,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" driver-long = "MongoDB Kotlin Sync Driver" driver-short = "Kotlin Sync driver" language = "Kotlin" -version-number = "5.4" +version-number = "5.5" full-version = "{+version-number+}.0" version = "v{+version-number+}" mdb-server = "MongoDB Server"