Skip to content

Commit d7c77f2

Browse files
DOCSP-17765 4.3 directive (#150)
* switched from 4.2 directive to a constant
1 parent c540e06 commit d7c77f2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+432
-433
lines changed

snooty.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ toc_landing_pages = [
88
]
99

1010
[constants]
11-
version = 4.0
11+
version = 4.3
1212
package-name-org = "mongodb-org"
13-
pgp-version = "{+version+}"
13+
api = "https://mongodb.github.io/mongo-java-driver/{+version+}"

source/api-documentation.txt

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

11-
BSON <https://mongodb.github.io/mongo-java-driver/4.3/apidocs/bson/index.html>
12-
Core <https://mongodb.github.io/mongo-java-driver/4.3/apidocs/mongodb-driver-core/index.html>
13-
Java Driver (modern API) <https://mongodb.github.io/mongo-java-driver/4.3/apidocs/mongodb-driver-sync/index.html>
14-
Java Driver (legacy API) <https://mongodb.github.io/mongo-java-driver/4.3/apidocs/mongodb-driver-legacy/index.html>
11+
BSON <{+api+}/apidocs/bson/index.html>
12+
Core <{+api+}/apidocs/mongodb-driver-core/index.html>
13+
Java Driver (modern API) <{+api+}/apidocs/mongodb-driver-sync/index.html>
14+
Java Driver (legacy API) <{+api+}/apidocs/mongodb-driver-legacy/index.html>
1515

source/faq.txt

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ tasks with the ``MongoClientSettings`` class:
5959
- :ref:`Get the Default Codec Registry <get-default-codec-registry-example>`
6060

6161
For more information on the ``MongoClientSettings`` class, see the
62-
:java-docs:`API Documentation for MongoClientSettings <apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html>`.
62+
`API Documentation for MongoClientSettings <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html>`__.
6363

6464
How do I fix: "javax.net.ssl.SSLHandshakeException: extension (5) should not be presented in certificate_request"?
6565
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -223,15 +223,15 @@ The output of the preceding code snippet should look like this:
223223
For more information on the legacy classes and methods used in the preceding example,
224224
see the following API Documentation pages:
225225

226-
- :java-docs:`Legacy API Javadoc Site <apidocs/mongodb-driver-legacy/index.html>`
227-
- :java-docs:`MongoClient <apidocs/mongodb-driver-legacy/com/mongodb/MongoClient.html>`
228-
- :java-docs:`DB <apidocs/mongodb-driver-legacy/com/mongodb/DB.html>`
229-
- :java-docs:`DBCollection <apidocs/mongodb-driver-legacy/com/mongodb/DBCollection.html>`
230-
- :java-docs:`DBObject <apidocs/mongodb-driver-core/com/mongodb/DBObject.html>`
231-
- :java-docs:`getDB() <apidocs/mongodb-driver-legacy/com/mongodb/MongoClient.html#getDB(java.lang.String)>`
232-
- :java-docs:`getCollection() <apidocs/mongodb-driver-legacy/com/mongodb/DB.html#getCollection(java.lang.String)>`
233-
- :java-docs:`find() <apidocs/mongodb-driver-legacy/com/mongodb/DBCollection.html#find()>`
234-
- :java-docs:`one() <apidocs/mongodb-driver-legacy/com/mongodb/DBCursor.html#one()>`
226+
- `Legacy API Javadoc Site <{+api+}/apidocs/mongodb-driver-legacy/index.html>`__
227+
- `MongoClient <{+api+}/apidocs/mongodb-driver-legacy/com/mongodb/MongoClient.html>`__
228+
- `DB <{+api+}/apidocs/mongodb-driver-legacy/com/mongodb/DB.html>`__
229+
- `DBCollection <{+api+}/apidocs/mongodb-driver-legacy/com/mongodb/DBCollection.html>`__
230+
- `DBObject <{+api+}/apidocs/mongodb-driver-core/com/mongodb/DBObject.html>`__
231+
- `getDB() <{+api+}/apidocs/mongodb-driver-legacy/com/mongodb/MongoClient.html#getDB(java.lang.String)>`__
232+
- `getCollection() <{+api+}/apidocs/mongodb-driver-legacy/com/mongodb/DB.html#getCollection(java.lang.String)>`__
233+
- `find() <{+api+}/apidocs/mongodb-driver-legacy/com/mongodb/DBCollection.html#find()>`__
234+
- `one() <{+api+}/apidocs/mongodb-driver-legacy/com/mongodb/DBCursor.html#one()>`__
235235

236236

237237
How do I use the legacy ``MongoClientOptions`` and ``MongoClientURI`` Classes?
@@ -263,10 +263,10 @@ Here is an example showing how to use the legacy ``MongoClientOptions`` and
263263
For more information on the legacy classes and methods used in the preceding example,
264264
see the following API Documentation pages:
265265

266-
- :java-docs:`Legacy API Javadoc Site <apidocs/mongodb-driver-legacy/index.html>`
267-
- :java-docs:`MongoClient <apidocs/mongodb-driver-legacy/com/mongodb/MongoClient.html>`
268-
- :java-docs:`MongoClientOptions <apidocs/mongodb-driver-legacy/com/mongodb/MongoClientOptions.html>`
269-
- :java-docs:`MongoClientURI <apidocs/mongodb-driver-legacy/com/mongodb/MongoClientURI.html>`
266+
- `Legacy API Javadoc Site <{+api+}/apidocs/mongodb-driver-legacy/index.html>`__
267+
- `MongoClient <{+api+}/apidocs/mongodb-driver-legacy/com/mongodb/MongoClient.html>`__
268+
- `MongoClientOptions <{+api+}/apidocs/mongodb-driver-legacy/com/mongodb/MongoClientOptions.html>`__
269+
- `MongoClientURI <{+api+}/apidocs/mongodb-driver-legacy/com/mongodb/MongoClientURI.html>`__
270270

271271
Support
272272
-------

source/fundamentals/aggregation.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Aggregation operations have some :manual:`limitations </core/aggregation-pipelin
5151
of 16 megabytes.
5252

5353
- Pipeline stages have a memory limit of 100 megabytes by default. If required, you may exceed this limit by using
54-
the :java-docs:`allowDiskUse <apidocs/mongodb-driver-sync/com/mongodb/client/AggregateIterable.html#allowDiskUse(java.lang.Boolean)>`
54+
the `allowDiskUse <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/AggregateIterable.html#allowDiskUse(java.lang.Boolean)>`__
5555
method.
5656

5757
.. important:: ``$graphLookup`` exception
@@ -121,7 +121,7 @@ To perform an aggregation, pass a list of aggregation stages to the
121121
``MongoCollection.aggregate()`` method.
122122

123123
The Java driver provides the
124-
:java-docs:`Aggregates <apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html>`
124+
`Aggregates <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html>`__
125125
helper class that contains builders for aggregation stages.
126126

127127
In the following example, the aggregation pipeline:
@@ -154,8 +154,8 @@ The preceding aggregation should produce the following results:
154154
For more information about the methods and classes mentioned in this section,
155155
see the following API Documentation:
156156

157-
- :java-docs:`MongoCollection.aggregate() <apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#aggregate(java.util.List)>`
158-
- :java-docs:`Aggregates.match <apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#match(org.bson.conversions.Bson)>`
157+
- `MongoCollection.aggregate() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#aggregate(java.util.List)>`__
158+
- `Aggregates.match <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#match(org.bson.conversions.Bson)>`__
159159

160160
Explain Aggregation Example
161161
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -196,9 +196,9 @@ following resources:
196196

197197
- :manual:`Explain Output </reference/explain-results/>` Server Manual Entry
198198
- :manual:`Query Plans </core/query-plans/>` Server Manual Entry
199-
- :java-docs:`ExplainVerbosity <apidocs/mongodb-driver-core/com/mongodb/ExplainVerbosity>` API Documentation
200-
- :java-docs:`explain() <apidocs/mongodb-driver-sync/com/mongodb/client/FindIterable.html#explain()>` API Documentation
201-
- :java-docs:`AggregateIterable <apidocs/mongodb-driver-sync/com/mongodb/client/AggregateIterable.html>` API Documentation
199+
- `ExplainVerbosity <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ExplainVerbosity>`__ API Documentation
200+
- `explain() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/FindIterable.html#explain()>`__ API Documentation
201+
- `AggregateIterable <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/AggregateIterable.html>`__ API Documentation
202202

203203
Aggregation Expression Example
204204
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -255,7 +255,7 @@ The preceding aggregation should produce the following results:
255255
For more information about the methods and classes mentioned in this section,
256256
see the following API Documentation:
257257

258-
- :java-docs:`Accumulators <apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`
259-
- :java-docs:`$group <apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#group(TExpression,java.util.List)>`
260-
- :java-docs:`$project <apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#project(org.bson.conversions.Bson)>`
261-
- :java-docs:`Projections <apidocs/mongodb-driver-core/com/mongodb/client/model/Projections.html>`
258+
- `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
259+
- `$group <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#group(TExpression,java.util.List)>`__
260+
- `$project <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#project(org.bson.conversions.Bson)>`__
261+
- `Projections <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Projections.html>`__

source/fundamentals/auth.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ mechanism:
148148

149149
To specify the default authentication mechanism using the
150150
``MongoCredential`` class, use the
151-
:java-docs:`createScramSha256Credential() <apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createScramSha256Credential(java.lang.String,java.lang.String,char[])>`
151+
`createScramSha256Credential() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createScramSha256Credential(java.lang.String,java.lang.String,char[])>`__
152152
method. Your code to instantiate a ``MongoClient`` should look something like this:
153153

154154
.. include:: /includes/fundamentals/code-snippets/auth-credentials-sha256.rst
@@ -200,7 +200,7 @@ mechanism:
200200

201201
To specify the default authentication mechanism using the
202202
``MongoCredential`` class, use the
203-
:java-docs:`createScramSha1Credential() <apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createScramSha1Credential(java.lang.String,java.lang.String,char[])>`
203+
`createScramSha1Credential() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createScramSha1Credential(java.lang.String,java.lang.String,char[])>`__
204204
method. Your code to instantiate a ``MongoClient`` should look something like this:
205205

206206
.. include:: /includes/fundamentals/code-snippets/auth-credentials-sha1.rst
@@ -278,7 +278,7 @@ mechanism:
278278

279279
To specify the ``MONGODB-AWS`` authentication mechanism using the
280280
``MongoCredential`` class, use the
281-
:java-docs:`createAwsCredential() <apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createAwsCredential(java.lang.String,char%5B%5D)>`
281+
`createAwsCredential() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createAwsCredential(java.lang.String,char%5B%5D)>`__
282282
method. Your code to instantiate a ``MongoClient`` should look something like this:
283283

284284
.. include:: /includes/fundamentals/code-snippets/auth-credentials-aws.rst
@@ -293,7 +293,7 @@ mechanism:
293293
in the ``authMechanism`` parameter and your session token in the
294294
``authMechanismProperties`` parameter. Then, add it to your
295295
``MongoClientSettings`` by calling the
296-
:java-docs:`applyConnectionString() <apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyConnectionString(com.mongodb.ConnectionString)>`
296+
`applyConnectionString() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyConnectionString(com.mongodb.ConnectionString)>`__
297297
method as follows:
298298

299299
.. include:: /includes/fundamentals/code-snippets/auth-credentials-aws-session.rst
@@ -302,7 +302,7 @@ mechanism:
302302

303303
You can include your AWS session token in your ``MongoCredential``
304304
instance by specifying it in a call to the
305-
:java-docs:`withMechanismProperty() <apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#withMechanismProperty(java.lang.String,T)>`
305+
`withMechanismProperty() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#withMechanismProperty(java.lang.String,T)>`__
306306
method as shown below:
307307

308308
.. code-block:: java
@@ -361,11 +361,11 @@ mechanism:
361361

362362
To specify the ``X.509`` authentication mechanism using the
363363
``MongoCredential`` class, use the
364-
:java-docs:`createMongoX509Credential() <apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createMongoX509Credential(java.lang.String)>`
364+
`createMongoX509Credential() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createMongoX509Credential(java.lang.String)>`__
365365
method. Also, enable TLS by calling the
366-
:java-docs:`applyToSslSettings() <apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToSslSettings(com.mongodb.Block)>`
366+
`applyToSslSettings() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToSslSettings(com.mongodb.Block)>`__
367367
method and setting the ``enabled`` property to ``true`` in the
368-
:java-docs:`SslSettings.Builder <apidocs/mongodb-driver-core/com/mongodb/connection/SslSettings.Builder.html>`
368+
`SslSettings.Builder <{+api+}/apidocs/mongodb-driver-core/com/mongodb/connection/SslSettings.Builder.html>`__
369369
block. Your code to instantiate a ``MongoClient`` should look something like this:
370370

371371
.. include:: /includes/fundamentals/code-snippets/auth-credentials-x509.rst

source/fundamentals/builders/aggregates.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Aggregates Builders
1515
Overview
1616
--------
1717

18-
In this guide, you can learn how to use the :java-docs:`Aggregates <apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates>`
18+
In this guide, you can learn how to use the `Aggregates <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates>`__
1919
class which provides static factory methods that build :manual:`aggregation pipeline
2020
stages </meta/aggregation-quick-reference/#stages>` in the MongoDB Java driver.
2121

@@ -220,7 +220,7 @@ for each distinct grouping.
220220

221221
.. tip::
222222

223-
The driver includes the :java-docs:`Accumulators <apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`
223+
The driver includes the `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
224224
class with static factory methods for each of the supported accumulators.
225225

226226
The following example creates a pipeline stage that groups documents by the value
@@ -472,7 +472,7 @@ into a bucket called "monster" for monstrously large screen sizes:
472472

473473
.. tip::
474474

475-
The driver includes the :java-docs:`Accumulators <apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`
475+
The driver includes the `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
476476
class with static factory methods for each of the supported accumulators.
477477

478478
.. literalinclude:: /includes/fundamentals/code-snippets/builders/AggBuilders.java
@@ -509,7 +509,7 @@ in a new field called ``avgPrice``:
509509

510510
.. tip::
511511

512-
The driver includes the :java-docs:`Accumulators <apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`
512+
The driver includes the `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
513513
class with static factory methods for each of the supported accumulators.
514514

515515
.. literalinclude:: /includes/fundamentals/code-snippets/builders/AggBuilders.java
@@ -547,7 +547,7 @@ on a specified span of documents in a collection.
547547

548548
.. tip:: Window Functions
549549

550-
The driver includes the `WindowedComputations <https://mongodb.github.io/mongo-java-driver/4.3/apidocs/mongodb-driver-core/com/mongodb/client/model/WindowedComputations.html>`__
550+
The driver includes the `WindowedComputations <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/WindowedComputations.html>`__
551551
class with static factory methods for each of the supported window operators.
552552

553553
The following example creates a pipeline stage that computes the

0 commit comments

Comments
 (0)