Skip to content

Update docs #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aclark4life merged 1 commit into from
Apr 22, 2025
Merged

Update docs #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Table of Contents

installation/index
third-party-library-support/index
supported-libraries/index

.. _`Django MongoDB Backend`: https://github.com/mongodb/django-mongodb-backend
.. _`Django fork`: https://github.com/mongodb-forks/django
Expand Down
0 ...-party-library-support/django-allauth.rst → ...ce/supported-libraries/django-allauth.rst
View file
Open in desktop
File renamed without changes.
0 ...-library-support/django-debug-toolbar.rst → ...ported-libraries/django-debug-toolbar.rst
View file
Open in desktop
File renamed without changes.
0 ...d-party-library-support/django-filter.rst → ...rce/supported-libraries/django-filter.rst
View file
Open in desktop
File renamed without changes.
0 ...library-support/django-rest-framework.rst → ...orted-libraries/django-rest-framework.rst
View file
Open in desktop
File renamed without changes.
35 changes: 35 additions & 0 deletions docs/source/supported-libraries/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Supported Libraries
===================

.. _third-party-libraries:

+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **Library** | **Test suites** | **Project examples** | **Known issues** | **Notes** |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-allauth** | :ref:`63% passing <django-allauth-results>` | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-debug-toolbar** | :ref:`73% passing <django-debug-toolbar-results>` | | SQL panel not supported. | |
| | | | Use MQL panel from | |
| | | | django-mongodb-extensions. | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-filter** | :ref:`93% passing <django-filter-results>` | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-rest-framework** | :ref:`81% passing <django-rest-framework-results>` | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| | | | In addition to custom apps and | Test results prior to |
| | | | migrations, requires custom | merge of `256`_. |
| | | | URL patterns. | |
| **wagtail** | :ref:`43% passing <wagtail-results>` | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+

.. toctree::
django-filter
django-rest-framework
django-debug-toolbar
django-allauth
wagtail
0 ...e/third-party-library-support/wagtail.rst → docs/source/supported-libraries/wagtail.rst
View file
Open in desktop
File renamed without changes.
44 changes: 0 additions & 44 deletions docs/source/third-party-library-support/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,13 @@
Third party library support
===========================

.. _third-party-libraries:

|

+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **Library** | **Test suites** | **Project examples** | **Known issues** | **Notes** |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-allauth** | :ref:`63% passing <django-allauth-results>` | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-debug-toolbar** | :ref:`73% passing <django-debug-toolbar-results>` | | SQL panel not supported. | |
| | | | Use MQL panel from | |
| | | | django-mongodb-extensions. | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-filter** | :ref:`93% passing <django-filter-results>` | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-rest-framework** | :ref:`81% passing <django-rest-framework-results>` | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| | | | In addition to custom apps and | Test results prior to |
| | | | migrations, requires custom | merge of `256`_. |
| | | | URL patterns. | |
| **wagtail** | :ref:`43% passing <wagtail-results>` | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+

Definition
-----------

This is the criteria used to determine if a third party library is supported
by Django MongoDB Backend. It is not a guarantee that the library will
work without issues, just that these criteria have been met.

Criteria
---------

.. toctree::
test-suites
project-examples
known-issues

Supported Libraries
-------------------

.. toctree::
django-filter
django-rest-framework
django-debug-toolbar
django-allauth
wagtail

.. _256: https://github.com/mongodb/django-mongodb-backend/pull/256