Added a FAQ to doc and Document the fact that we dont support motor

2019-09-10 23:02:32 +02:00
parent 02a920feea
commit 71e8d9a490
2 changed files with 17 additions and 0 deletions
--- a/docs/faq.rst
+++ 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/
+
--- 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