From 255858154e39dfa95c9c034a1321e6f9d109cb9f Mon Sep 17 00:00:00 2001 From: norareidy Date: Mon, 13 Jan 2025 11:55:24 -0500 Subject: [PATCH 1/5] DOCSP-46413: Compatibility --- source/django-compatibility.txt | 58 +++++++++++++++++++ .../language-compatibility-table-django.rst | 31 ++++++++++ 2 files changed, 89 insertions(+) create mode 100644 source/django-compatibility.txt create mode 100644 source/includes/language-compatibility-table-django.rst diff --git a/source/django-compatibility.txt b/source/django-compatibility.txt new file mode 100644 index 00000000..9664208c --- /dev/null +++ b/source/django-compatibility.txt @@ -0,0 +1,58 @@ +.. _django-compatibility: + +============= +Compatibility +============= + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: backwards compatibility, versions, upgrade + +MongoDB Compatibility +--------------------- + +{+django-odm+} uses the PyMongo driver to interact with MongoDB. Your +application's supported {+mdb-server+} versions depend on its PyMongo version. +The following compatibility table specifies the recommended version or versions +of PyMongo for use with a specific version of MongoDB. + +The first column lists the driver version. + +.. sharedinclude:: dbx/lifecycle-schedule-callout.rst + +.. sharedinclude:: dbx/compatibility-table-legend.rst + +.. include:: /includes/mongodb-compatibility-table-pymongo.rst + +Driver Compatibility +-------------------- + +{+django-odm+} supports PyMongo versions 4.6 and later. + +Language Compatibility +---------------------- + +The following compatibility table specifies the recommended version of +{+django-odm+} for use with a specific version of Python. +The first column lists the driver version. + +.. include:: /includes/language-compatibility-table-django.rst + +For more information on how to read the compatibility tables, see our guide on +:ref:`MongoDB Compatibility Tables. ` + +Django Compatibility +-------------------- + +Your major and minor version of {+django-odm+} must match your Django version. +For example, {+django-odm+} version 5.1 requires Django 5.1. The minimum supported +Django version is v5.0. \ No newline at end of file diff --git a/source/includes/language-compatibility-table-django.rst b/source/includes/language-compatibility-table-django.rst new file mode 100644 index 00000000..71991032 --- /dev/null +++ b/source/includes/language-compatibility-table-django.rst @@ -0,0 +1,31 @@ +.. list-table:: + :header-rows: 1 + :stub-columns: 1 + :class: compatibility-large + + * - {+django-odm+} Version + - Python 3.13 + - Python 3.12 + - Python 3.11 + - Python 3.10 + - Python 3.9 + - Python 3.8 + - Python 3.7 + + * - 5.1 + - + - ✓ + - ✓ + - ✓ + - + - + - + + * - 5.0 + - + - ✓ + - ✓ + - ✓ + - + - + - From cfda836f312c5acf5cfb3d3b51f730ec9f86f672 Mon Sep 17 00:00:00 2001 From: norareidy Date: Mon, 13 Jan 2025 15:03:13 -0500 Subject: [PATCH 2/5] edits --- snooty.toml | 1 + source/django-compatibility.txt | 10 +++++----- .../includes/language-compatibility-table-django.rst | 8 +------- 3 files changed, 7 insertions(+), 12 deletions(-) diff --git a/snooty.toml b/snooty.toml index de16c44e..eead367f 100644 --- a/snooty.toml +++ b/snooty.toml @@ -25,6 +25,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" driver-short = "PyMongo" driver-long = "PyMongo, the MongoDB synchronous Python driver," driver-async = "PyMongo Async" +django-odm = "MongoDB Backend for Django" language = "Python" mdb-server = "MongoDB Server" mongo-community = "MongoDB Community Edition" diff --git a/source/django-compatibility.txt b/source/django-compatibility.txt index 9664208c..5ff49089 100644 --- a/source/django-compatibility.txt +++ b/source/django-compatibility.txt @@ -20,8 +20,8 @@ Compatibility MongoDB Compatibility --------------------- -{+django-odm+} uses the PyMongo driver to interact with MongoDB. Your -application's supported {+mdb-server+} versions depend on its PyMongo version. +{+django-odm+} uses the PyMongo driver to interact with MongoDB. The {+mdb-server+} +versions that your application supports depend on your PyMongo version. The following compatibility table specifies the recommended version or versions of PyMongo for use with a specific version of MongoDB. @@ -33,8 +33,8 @@ The first column lists the driver version. .. include:: /includes/mongodb-compatibility-table-pymongo.rst -Driver Compatibility --------------------- +PyMongo Compatibility +--------------------- {+django-odm+} supports PyMongo versions 4.6 and later. @@ -55,4 +55,4 @@ Django Compatibility Your major and minor version of {+django-odm+} must match your Django version. For example, {+django-odm+} version 5.1 requires Django 5.1. The minimum supported -Django version is v5.0. \ No newline at end of file +Django version is 5.0. \ No newline at end of file diff --git a/source/includes/language-compatibility-table-django.rst b/source/includes/language-compatibility-table-django.rst index 71991032..03ad4102 100644 --- a/source/includes/language-compatibility-table-django.rst +++ b/source/includes/language-compatibility-table-django.rst @@ -3,14 +3,12 @@ :stub-columns: 1 :class: compatibility-large - * - {+django-odm+} Version + * - Django MongoDB Backend Version - Python 3.13 - Python 3.12 - Python 3.11 - Python 3.10 - Python 3.9 - - Python 3.8 - - Python 3.7 * - 5.1 - @@ -18,8 +16,6 @@ - ✓ - ✓ - - - - - * - 5.0 - @@ -27,5 +23,3 @@ - ✓ - ✓ - - - - - From f4fac9d9ab1890852a63995e289a181a8b38dd60 Mon Sep 17 00:00:00 2001 From: norareidy Date: Mon, 13 Jan 2025 15:08:27 -0500 Subject: [PATCH 3/5] edit --- source/django-compatibility.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/django-compatibility.txt b/source/django-compatibility.txt index 5ff49089..80c74187 100644 --- a/source/django-compatibility.txt +++ b/source/django-compatibility.txt @@ -43,7 +43,7 @@ Language Compatibility The following compatibility table specifies the recommended version of {+django-odm+} for use with a specific version of Python. -The first column lists the driver version. +The first column lists the ODM version. .. include:: /includes/language-compatibility-table-django.rst From 5aaac8f7cdb604d0e368ed72719197037721c1c6 Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 14 Jan 2025 11:07:25 -0500 Subject: [PATCH 4/5] AC feedback --- snooty.toml | 2 +- source/django-compatibility.txt | 29 +++++++------------ .../language-compatibility-table-django.rst | 2 +- 3 files changed, 13 insertions(+), 20 deletions(-) diff --git a/snooty.toml b/snooty.toml index eead367f..1f5fb267 100644 --- a/snooty.toml +++ b/snooty.toml @@ -25,7 +25,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" driver-short = "PyMongo" driver-long = "PyMongo, the MongoDB synchronous Python driver," driver-async = "PyMongo Async" -django-odm = "MongoDB Backend for Django" +django-odm = "Django MongoDB Backend" language = "Python" mdb-server = "MongoDB Server" mongo-community = "MongoDB Community Edition" diff --git a/source/django-compatibility.txt b/source/django-compatibility.txt index 80c74187..572ab6d8 100644 --- a/source/django-compatibility.txt +++ b/source/django-compatibility.txt @@ -22,22 +22,22 @@ MongoDB Compatibility {+django-odm+} uses the PyMongo driver to interact with MongoDB. The {+mdb-server+} versions that your application supports depend on your PyMongo version. -The following compatibility table specifies the recommended version or versions -of PyMongo for use with a specific version of MongoDB. - -The first column lists the driver version. - -.. sharedinclude:: dbx/lifecycle-schedule-callout.rst - -.. sharedinclude:: dbx/compatibility-table-legend.rst - -.. include:: /includes/mongodb-compatibility-table-pymongo.rst +To view PyMongo and {+mdb-server+} compatibility information, see `MongoDB Compatibility +`__ +in the PyMongo documentation. PyMongo Compatibility --------------------- {+django-odm+} supports PyMongo versions 4.6 and later. +Django Compatibility +-------------------- + +Your major and minor version of {+django-odm+} must match your Django version. +For example, {+django-odm+} version 5.1 requires Django 5.1. The minimum supported +Django version is 5.0. + Language Compatibility ---------------------- @@ -48,11 +48,4 @@ The first column lists the ODM version. .. include:: /includes/language-compatibility-table-django.rst For more information on how to read the compatibility tables, see our guide on -:ref:`MongoDB Compatibility Tables. ` - -Django Compatibility --------------------- - -Your major and minor version of {+django-odm+} must match your Django version. -For example, {+django-odm+} version 5.1 requires Django 5.1. The minimum supported -Django version is 5.0. \ No newline at end of file +:ref:`MongoDB Compatibility Tables. ` \ No newline at end of file diff --git a/source/includes/language-compatibility-table-django.rst b/source/includes/language-compatibility-table-django.rst index 03ad4102..f17254e9 100644 --- a/source/includes/language-compatibility-table-django.rst +++ b/source/includes/language-compatibility-table-django.rst @@ -3,7 +3,7 @@ :stub-columns: 1 :class: compatibility-large - * - Django MongoDB Backend Version + * - {+django-odm+} Version - Python 3.13 - Python 3.12 - Python 3.11 From e72ba0949086e450695c3f22561d023e12f48b4c Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 15 Jan 2025 16:29:02 -0500 Subject: [PATCH 5/5] JS feedback --- source/django-compatibility.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/source/django-compatibility.txt b/source/django-compatibility.txt index 572ab6d8..8fac872a 100644 --- a/source/django-compatibility.txt +++ b/source/django-compatibility.txt @@ -43,7 +43,6 @@ Language Compatibility The following compatibility table specifies the recommended version of {+django-odm+} for use with a specific version of Python. -The first column lists the ODM version. .. include:: /includes/language-compatibility-table-django.rst