DOCSP-46413: Compatibility

source/compatibility.txt

@@ -0,0 +1,50 @@
+.. _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. The {+mdb-server+}
+versions that your application supports depend on your PyMongo version.
+To view PyMongo and {+mdb-server+} compatibility information, see `MongoDB Compatibility
+<https://www.mongodb.com/docs/languages/python/pymongo-driver/current/compatibility/#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
+----------------------
+
+The following compatibility table specifies the recommended version of
+{+django-odm+} for use with a specific version of Python:
+
+.. include:: /includes/language-compatibility-table-django.rst
+
+For more information on how to read the compatibility tables, see our guide on
+:driver:`MongoDB Compatibility Tables. </about-compatibility>`

source/includes/language-compatibility-table-django.rst

@@ -0,0 +1,25 @@
+.. 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
+
+   * - 5.1
+     - 
+     - ✓ 
+     - ✓ 
+     - ✓ 
+     -
+
+   * - 5.0
+     - 
+     - ✓ 
+     - ✓ 
+     - ✓ 
+     -

source/index.txt

@@ -12,6 +12,7 @@ Django MongoDB Backend
 .. toctree::
 
     Issues & Help </issues-and-help>
+    Compatibility </compatibility>
 
 
 .. TODO:
@@ -20,7 +21,6 @@ Django MongoDB Backend
    Interact with Data </interact-data>
    Model Your Data </model-data>
    Django Feature Limitations </feature-limitations>
-   Compatibility </compatibility>
    API Documentation <{+api+}>
 
 Introduction
@@ -61,12 +61,12 @@ a Django database backend that uses PyMongo to connect to MongoDB.
 .. Learn about the Django features that {+django-odm+} does not support
    in the :ref:`django-feature-limitations` section.
 
-.. Compatibility
-.. -------------
+Compatibility
+-------------
 
-.. Learn about the versions of {+mdb-server+}, PyMongo, Python, and Django
-   that are compatible with {+django-odm+} in the :ref:`Compatibility <django-compatibility>`
-   section.
+Learn about the versions of {+mdb-server+}, PyMongo, Python, and Django
+that are compatible with {+django-odm+} in the :ref:`Compatibility <django-compatibility>`
+section.
 
 Issues & Help
 -------------