Skip to content

Commit c492f0a

Browse files
aclark4lifeaclark4life
authored
Merge pull request #20 from aclark4life/main
Update docs
2 parents 5f271f2 + 73e576d commit c492f0a

File tree

8 files changed

+36
-44
lines changed

8 files changed

+36
-44
lines changed

‎docs/source/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Table of Contents
2727

2828
installation/index
2929
third-party-library-support/index
30+
supported-libraries/index
3031

3132
.. _`Django MongoDB Backend`: https://github.com/mongodb/django-mongodb-backend
3233
.. _`Django fork`: https://github.com/mongodb-forks/django

‎docs/source/third-party-library-support/django-allauth.rst‎ renamed to ‎docs/source/supported-libraries/django-allauth.rst‎

File renamed without changes.

‎docs/source/third-party-library-support/django-debug-toolbar.rst‎ renamed to ‎docs/source/supported-libraries/django-debug-toolbar.rst‎

File renamed without changes.

‎docs/source/third-party-library-support/django-filter.rst‎ renamed to ‎docs/source/supported-libraries/django-filter.rst‎

File renamed without changes.

‎docs/source/third-party-library-support/django-rest-framework.rst‎ renamed to ‎docs/source/supported-libraries/django-rest-framework.rst‎

File renamed without changes.

‎docs/source/supported-libraries/index.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Supported Libraries
2+
===================
3+
4+
.. _third-party-libraries:
5+
6+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
7+
| **Library** | **Test suites** | **Project examples** | **Known issues** | **Notes** |
8+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
9+
| **django-allauth** | :ref:`63% passing <django-allauth-results>` | | | |
10+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
11+
| **django-debug-toolbar** | :ref:`73% passing <django-debug-toolbar-results>` | | SQL panel not supported. | |
12+
| | | | Use MQL panel from | |
13+
| | | | django-mongodb-extensions. | |
14+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
15+
| **django-filter** | :ref:`93% passing <django-filter-results>` | | | |
16+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
17+
| **django-rest-framework** | :ref:`81% passing <django-rest-framework-results>` | | | |
18+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
19+
| | | | In addition to custom apps and | Test results prior to |
20+
| | | | migrations, requires custom | merge of `256`_. |
21+
| | | | URL patterns. | |
22+
| **wagtail** | :ref:`43% passing <wagtail-results>` | | | |
23+
| | | | | |
24+
| | | | | |
25+
| | | | | |
26+
| | | | | |
27+
| | | | | |
28+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
29+
30+
.. toctree::
31+
django-filter
32+
django-rest-framework
33+
django-debug-toolbar
34+
django-allauth
35+
wagtail

‎docs/source/third-party-library-support/wagtail.rst‎ renamed to ‎docs/source/supported-libraries/wagtail.rst‎

File renamed without changes.

‎docs/source/third-party-library-support/index.rst‎

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,13 @@
11
Third party library support
22
===========================
33

4-
.. _third-party-libraries:
5-
6-
|
7-
8-
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
9-
| **Library** | **Test suites** | **Project examples** | **Known issues** | **Notes** |
10-
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
11-
| **django-allauth** | :ref:`63% passing <django-allauth-results>` | | | |
12-
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
13-
| **django-debug-toolbar** | :ref:`73% passing <django-debug-toolbar-results>` | | SQL panel not supported. | |
14-
| | | | Use MQL panel from | |
15-
| | | | django-mongodb-extensions. | |
16-
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
17-
| **django-filter** | :ref:`93% passing <django-filter-results>` | | | |
18-
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
19-
| **django-rest-framework** | :ref:`81% passing <django-rest-framework-results>` | | | |
20-
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
21-
| | | | In addition to custom apps and | Test results prior to |
22-
| | | | migrations, requires custom | merge of `256`_. |
23-
| | | | URL patterns. | |
24-
| **wagtail** | :ref:`43% passing <wagtail-results>` | | | |
25-
| | | | | |
26-
| | | | | |
27-
| | | | | |
28-
| | | | | |
29-
| | | | | |
30-
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
31-
32-
Definition
33-
-----------
34-
354
This is the criteria used to determine if a third party library is supported
365
by Django MongoDB Backend. It is not a guarantee that the library will
376
work without issues, just that these criteria have been met.
387

39-
Criteria
40-
---------
41-
428
.. toctree::
439
test-suites
4410
project-examples
4511
known-issues
4612

47-
Supported Libraries
48-
-------------------
49-
50-
.. toctree::
51-
django-filter
52-
django-rest-framework
53-
django-debug-toolbar
54-
django-allauth
55-
wagtail
56-
5713
.. _256: https://github.com/mongodb/django-mongodb-backend/pull/256

0 commit comments

Comments
 (0)