Skip to content

Commit f8c7bd5

Browse files
authored
DOCSP-46413: Compatibility (#5)
* DOCSP-46413: Compatibility * github workflows * fix link * fix
1 parent 5d7715e commit f8c7bd5

File tree

5 files changed

+81
-6
lines changed

5 files changed

+81
-6
lines changed
File renamed without changes.

source/compatibility.txt

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
.. _django-compatibility:
2+
3+
=============
4+
Compatibility
5+
=============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. facet::
14+
:name: genre
15+
:values: reference
16+
17+
.. meta::
18+
:keywords: backwards compatibility, versions, upgrade
19+
20+
MongoDB Compatibility
21+
---------------------
22+
23+
{+django-odm+} uses the PyMongo driver to interact with MongoDB. The {+mdb-server+}
24+
versions that your application supports depend on your PyMongo version.
25+
To view PyMongo and {+mdb-server+} compatibility information, see `MongoDB Compatibility
26+
<https://www.mongodb.com/docs/languages/python/pymongo-driver/current/compatibility/#mongodb-compatibility>`__
27+
in the PyMongo documentation.
28+
29+
PyMongo Compatibility
30+
---------------------
31+
32+
{+django-odm+} supports PyMongo versions 4.6 and later.
33+
34+
Django Compatibility
35+
--------------------
36+
37+
Your major and minor version of {+django-odm+} must match your Django version.
38+
For example, {+django-odm+} version 5.1 requires Django 5.1. The minimum supported
39+
Django version is 5.0.
40+
41+
Language Compatibility
42+
----------------------
43+
44+
The following compatibility table specifies the recommended version of
45+
{+django-odm+} for use with a specific version of Python:
46+
47+
.. include:: /includes/language-compatibility-table-django.rst
48+
49+
For more information on how to read the compatibility tables, see our guide on
50+
:driver:`MongoDB Compatibility Tables. </about-compatibility>`
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:stub-columns: 1
4+
:class: compatibility-large
5+
6+
* - {+django-odm+} Version
7+
- Python 3.13
8+
- Python 3.12
9+
- Python 3.11
10+
- Python 3.10
11+
- Python 3.9
12+
13+
* - 5.1
14+
-
15+
- ✓
16+
- ✓
17+
- ✓
18+
-
19+
20+
* - 5.0
21+
-
22+
- ✓
23+
- ✓
24+
- ✓
25+
-

source/index.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Django MongoDB Backend
1212
.. toctree::
1313

1414
Issues & Help </issues-and-help>
15+
Compatibility </compatibility>
1516

1617

1718
.. TODO:
@@ -20,7 +21,6 @@ Django MongoDB Backend
2021
Interact with Data </interact-data>
2122
Model Your Data </model-data>
2223
Django Feature Limitations </feature-limitations>
23-
Compatibility </compatibility>
2424
API Documentation <{+api+}>
2525

2626
Introduction
@@ -61,12 +61,12 @@ a Django database backend that uses PyMongo to connect to MongoDB.
6161
.. Learn about the Django features that {+django-odm+} does not support
6262
in the :ref:`django-feature-limitations` section.
6363

64-
.. Compatibility
65-
.. -------------
64+
Compatibility
65+
-------------
6666

67-
.. Learn about the versions of {+mdb-server+}, PyMongo, Python, and Django
68-
that are compatible with {+django-odm+} in the :ref:`Compatibility <django-compatibility>`
69-
section.
67+
Learn about the versions of {+mdb-server+}, PyMongo, Python, and Django
68+
that are compatible with {+django-odm+} in the :ref:`Compatibility <django-compatibility>`
69+
section.
7070

7171
Issues & Help
7272
-------------

0 commit comments

Comments
 (0)