From 94e0e4f8fb56b4a9946926a5e9af20b52c4e2c1a Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Tue, 22 Apr 2025 12:36:23 -0400 Subject: [PATCH] Update docs --- .../django-allauth.rst | 0 .../django-debug-toolbar.rst | 0 .../django-filter.rst | 0 .../django-rest-framework.rst | 0 .../third-party-library-support/index.rst | 41 +++++++++++++++++-- .../supported-libraries/index.rst | 38 ----------------- .../{supported-libraries => }/wagtail.rst | 0 7 files changed, 37 insertions(+), 42 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%) delete mode 100644 docs/source/third-party-library-support/supported-libraries/index.rst rename docs/source/third-party-library-support/{supported-libraries => }/wagtail.rst (100%) diff --git a/docs/source/third-party-library-support/supported-libraries/django-allauth.rst b/docs/source/third-party-library-support/django-allauth.rst similarity index 100% rename from docs/source/third-party-library-support/supported-libraries/django-allauth.rst rename to docs/source/third-party-library-support/django-allauth.rst diff --git a/docs/source/third-party-library-support/supported-libraries/django-debug-toolbar.rst b/docs/source/third-party-library-support/django-debug-toolbar.rst similarity index 100% rename from docs/source/third-party-library-support/supported-libraries/django-debug-toolbar.rst rename to docs/source/third-party-library-support/django-debug-toolbar.rst diff --git a/docs/source/third-party-library-support/supported-libraries/django-filter.rst b/docs/source/third-party-library-support/django-filter.rst similarity index 100% rename from docs/source/third-party-library-support/supported-libraries/django-filter.rst rename to docs/source/third-party-library-support/django-filter.rst diff --git a/docs/source/third-party-library-support/supported-libraries/django-rest-framework.rst b/docs/source/third-party-library-support/django-rest-framework.rst similarity index 100% rename from docs/source/third-party-library-support/supported-libraries/django-rest-framework.rst rename to docs/source/third-party-library-support/django-rest-framework.rst diff --git a/docs/source/third-party-library-support/index.rst b/docs/source/third-party-library-support/index.rst index 52e92ba..89376c8 100644 --- a/docs/source/third-party-library-support/index.rst +++ b/docs/source/third-party-library-support/index.rst @@ -1,6 +1,34 @@ 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 ----------- @@ -16,9 +44,14 @@ Criteria project-examples known-issues - -Suported Libraries ------------------- +Supported Libraries +------------------- .. toctree:: - supported-libraries/index + django-filter + django-rest-framework + django-debug-toolbar + django-allauth + wagtail + +.. _256: https://github.com/mongodb/django-mongodb-backend/pull/256 diff --git a/docs/source/third-party-library-support/supported-libraries/index.rst b/docs/source/third-party-library-support/supported-libraries/index.rst deleted file mode 100644 index 00d81dd..0000000 --- a/docs/source/third-party-library-support/supported-libraries/index.rst +++ /dev/null @@ -1,38 +0,0 @@ - -.. _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-allauth - django-debug-toolbar - django-filter - django-rest-framework - wagtail - - -.. _256: https://github.com/mongodb/django-mongodb-backend/pull/256 diff --git a/docs/source/third-party-library-support/supported-libraries/wagtail.rst b/docs/source/third-party-library-support/wagtail.rst similarity index 100% rename from docs/source/third-party-library-support/supported-libraries/wagtail.rst rename to docs/source/third-party-library-support/wagtail.rst