diff --git a/github/pull_request_template.md b/.github/pull_request_template.md similarity index 100% rename from github/pull_request_template.md rename to .github/pull_request_template.md diff --git a/github/workflows/add-netlify-links.yml b/.github/workflows/add-netlify-links.yml similarity index 100% rename from github/workflows/add-netlify-links.yml rename to .github/workflows/add-netlify-links.yml diff --git a/source/compatibility.txt b/source/compatibility.txt new file mode 100644 index 0000000..d3c7680 --- /dev/null +++ b/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 +`__ +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. ` \ 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 0000000..0af6f56 --- /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 + - + - ✓ + - ✓ + - ✓ + - \ No newline at end of file diff --git a/source/index.txt b/source/index.txt index e6f4a63..ea41052 100644 --- a/source/index.txt +++ b/source/index.txt @@ -12,6 +12,7 @@ Django MongoDB Backend .. toctree:: Issues & Help + Compatibility .. TODO: @@ -20,7 +21,6 @@ Django MongoDB Backend Interact with Data Model Your Data Django Feature Limitations - 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 ` - section. +Learn about the versions of {+mdb-server+}, PyMongo, Python, and Django +that are compatible with {+django-odm+} in the :ref:`Compatibility ` +section. Issues & Help -------------