From 73e576d12477b82fc8dd2ae25bf9a6e29281de5d Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Tue, 22 Apr 2025 19:05:23 -0400 Subject: [PATCH] Update docs --- docs/source/index.rst | 1 + .../django-allauth.rst | 0 .../django-debug-toolbar.rst | 0 .../django-filter.rst | 0 .../django-rest-framework.rst | 0 docs/source/supported-libraries/index.rst | 35 +++++++++++++++ .../wagtail.rst | 0 .../third-party-library-support/index.rst | 44 ------------------- 8 files changed, 36 insertions(+), 44 deletions(-) rename docs/source/{third-party-library-support => supported-libraries}/django-allauth.rst (100%) rename docs/source/{third-party-library-support => supported-libraries}/django-debug-toolbar.rst (100%) rename docs/source/{third-party-library-support => supported-libraries}/django-filter.rst (100%) rename docs/source/{third-party-library-support => supported-libraries}/django-rest-framework.rst (100%) create mode 100644 docs/source/supported-libraries/index.rst rename docs/source/{third-party-library-support => supported-libraries}/wagtail.rst (100%) diff --git a/docs/source/index.rst b/docs/source/index.rst index a13771c..49ada8d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 diff --git a/docs/source/third-party-library-support/django-allauth.rst b/docs/source/supported-libraries/django-allauth.rst similarity index 100% rename from docs/source/third-party-library-support/django-allauth.rst rename to docs/source/supported-libraries/django-allauth.rst diff --git a/docs/source/third-party-library-support/django-debug-toolbar.rst b/docs/source/supported-libraries/django-debug-toolbar.rst similarity index 100% rename from docs/source/third-party-library-support/django-debug-toolbar.rst rename to docs/source/supported-libraries/django-debug-toolbar.rst diff --git a/docs/source/third-party-library-support/django-filter.rst b/docs/source/supported-libraries/django-filter.rst similarity index 100% rename from docs/source/third-party-library-support/django-filter.rst rename to docs/source/supported-libraries/django-filter.rst diff --git a/docs/source/third-party-library-support/django-rest-framework.rst b/docs/source/supported-libraries/django-rest-framework.rst similarity index 100% rename from docs/source/third-party-library-support/django-rest-framework.rst rename to docs/source/supported-libraries/django-rest-framework.rst diff --git a/docs/source/supported-libraries/index.rst b/docs/source/supported-libraries/index.rst new file mode 100644 index 0000000..cc22c20 --- /dev/null +++ b/docs/source/supported-libraries/index.rst @@ -0,0 +1,35 @@ +Supported Libraries +=================== + +.. _third-party-libraries: + ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| **Library** | **Test suites** | **Project examples** | **Known issues** | **Notes** | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| **django-allauth** | :ref:`63% passing ` | | | | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| **django-debug-toolbar** | :ref:`73% passing ` | | SQL panel not supported. | | +| | | | Use MQL panel from | | +| | | | django-mongodb-extensions. | | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| **django-filter** | :ref:`93% passing ` | | | | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| **django-rest-framework** | :ref:`81% passing ` | | | | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| | | | In addition to custom apps and | Test results prior to | +| | | | migrations, requires custom | merge of `256`_. | +| | | | URL patterns. | | +| **wagtail** | :ref:`43% passing ` | | | | +| | | | | | +| | | | | | +| | | | | | +| | | | | | +| | | | | | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ + +.. toctree:: + django-filter + django-rest-framework + django-debug-toolbar + django-allauth + wagtail diff --git a/docs/source/third-party-library-support/wagtail.rst b/docs/source/supported-libraries/wagtail.rst similarity index 100% rename from docs/source/third-party-library-support/wagtail.rst rename to docs/source/supported-libraries/wagtail.rst diff --git a/docs/source/third-party-library-support/index.rst b/docs/source/third-party-library-support/index.rst index 89376c8..a6f58de 100644 --- a/docs/source/third-party-library-support/index.rst +++ b/docs/source/third-party-library-support/index.rst @@ -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-debug-toolbar** | :ref:`73% passing ` | | SQL panel not supported. | | -| | | | Use MQL panel from | | -| | | | django-mongodb-extensions. | | -+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ -| **django-filter** | :ref:`93% passing ` | | | | -+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ -| **django-rest-framework** | :ref:`81% passing ` | | | | -+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ -| | | | In addition to custom apps and | Test results prior to | -| | | | migrations, requires custom | merge of `256`_. | -| | | | URL patterns. | | -| **wagtail** | :ref:`43% passing ` | | | | -| | | | | | -| | | | | | -| | | | | | -| | | | | | -| | | | | | -+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ - -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