diff --git a/snooty.toml b/snooty.toml index de16c44e..1f5fb267 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 = "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 new file mode 100644 index 00000000..8fac872a --- /dev/null +++ b/source/django-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 +`__ +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 +: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 new file mode 100644 index 00000000..f17254e9 --- /dev/null +++ b/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 + - + - ✓ + - ✓ + - ✓ + -