From 71e8d9a49067f1c790739f43fb3ff35baf01c458 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastien=20G=C3=A9rard?= Date: Tue, 10 Sep 2019 23:02:32 +0200 Subject: [PATCH 1/2] Added a FAQ to doc and Document the fact that we dont support motor --- docs/faq.rst | 13 +++++++++++++ docs/index.rst | 4 ++++ 2 files changed, 17 insertions(+) create mode 100644 docs/faq.rst diff --git a/docs/faq.rst b/docs/faq.rst new file mode 100644 index 00000000..27cd6937 --- /dev/null +++ b/docs/faq.rst @@ -0,0 +1,13 @@ +========================== +Frequently Asked Questions +========================== + +Does MongoEngine support asynchronous drivers (Motor, TxMongo)? +--------------------------------------------------------------- + +No, MongoEngine is exclusively based on PyMongo and isn't designed to support other driver. +If this is a requirement for your project, check the alternative: `uMongo`_ and `MotorEngine`_. + +.. _uMongo: https://umongo.readthedocs.io/ +.. _MotorEngine: https://motorengine.readthedocs.io/ + diff --git a/docs/index.rst b/docs/index.rst index 2102df02..686ef547 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,9 @@ MongoDB. To install it, simply run :doc:`upgrade` How to upgrade MongoEngine. +:doc:`faq` + Frequently Asked Questions + :doc:`django` Using MongoEngine and Django @@ -73,6 +76,7 @@ formats for offline reading. apireference changelog upgrade + faq django Indices and tables From 19f12f3f2f380987c23dcafb8f288eb51177363d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastien=20G=C3=A9rard?= Date: Fri, 4 Oct 2019 21:51:12 +0200 Subject: [PATCH 2/2] document pymongo in RTD and make it point to github --- docs/index.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 686ef547..662968d4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,6 +29,12 @@ MongoDB. To install it, simply run :doc:`django` Using MongoEngine and Django +MongoDB and driver support +-------------------------- + +MongoEngine is based on the PyMongo driver and tested against multiple versions of MongoDB. +For further details, please refer to the `readme `_. + Community ---------