From 6ec947faa0fe098eeb59a62b15ef639900f072ff Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Mon, 21 Apr 2025 15:47:37 -0400 Subject: [PATCH 1/2] Fix repo --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index db92aa4..ff37924 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -48,7 +48,7 @@ dev = [ "flask-pymongo @ git+ssh://git@github.com/mongodb-labs/flask-pymongo", "langchain-mongodb @ git+ssh://git@github.com/langchain-ai/langchain-mongodb@main", "mongo-python-driver @ git+ssh://git@github.com/mongodb/mongo-python-driver@master", - "specifications @ git+ssh://git@github.com:mongodb/specifications@master", + "specifications @ git+ssh://git@github.com/mongodb/specifications@master", "wagtail @ git+ssh://git@github.com/mongodb-forks/wagtail@main", "wagtail-mongodb-project @ git+ssh://git@github.com/mongodb-labs/wagtail-mongodb-project@main", "xmlsec @ git+ssh://git@github.com/xmlsec/python-xmlsec@main", From 06bc680529f137cb7e61e79ee126c080820894e2 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Tue, 22 Apr 2025 12:16:39 -0400 Subject: [PATCH 2/2] Update docs --- docs/source/index.rst | 11 +- docs/source/installation/index.rst | 4 +- .../supported-libraries/django-allauth.rst | 220 ------------------ .../django-debug-toolbar.rst | 84 ------- .../supported-libraries/django-filter.rst | 78 ------- .../django-rest-framework.rst | 122 ---------- docs/source/supported-libraries/wagtail.rst | 136 ----------- .../third-party-library-support/index.rst | 9 +- .../supported-libraries/django-allauth.rst | 23 ++ .../django-debug-toolbar.rst | 23 ++ .../supported-libraries/django-filter.rst | 23 ++ .../django-rest-framework.rst | 23 ++ .../supported-libraries/index.rst | 9 - .../supported-libraries/wagtail.rst | 28 +++ justfile | 3 +- pyproject.toml | 1 + 16 files changed, 140 insertions(+), 657 deletions(-) delete mode 100644 docs/source/supported-libraries/django-allauth.rst delete mode 100644 docs/source/supported-libraries/django-debug-toolbar.rst delete mode 100644 docs/source/supported-libraries/django-filter.rst delete mode 100644 docs/source/supported-libraries/django-rest-framework.rst delete mode 100644 docs/source/supported-libraries/wagtail.rst create mode 100644 docs/source/third-party-library-support/supported-libraries/django-allauth.rst create mode 100644 docs/source/third-party-library-support/supported-libraries/django-debug-toolbar.rst create mode 100644 docs/source/third-party-library-support/supported-libraries/django-filter.rst create mode 100644 docs/source/third-party-library-support/supported-libraries/django-rest-framework.rst rename docs/source/{ => third-party-library-support}/supported-libraries/index.rst (98%) create mode 100644 docs/source/third-party-library-support/supported-libraries/wagtail.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index b6be976..7edd2c2 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,19 +16,22 @@ About This library provides the ``dm`` command which can be used for: -- Testing `Django MongoDB Backend`_ with MongoDB's `Django fork`_ and :ref:`third party library test suites `. -- Testing Django projects with `Django MongoDB Backend`_ and :ref:`third party libraries `. +- Testing + + + - :ref:`Third party library test suites ` with `Django MongoDB Backend`_ and MongoDB's `Django fork`_. + - `Django projects`_ with `Django MongoDB Backend`_ and :ref:`third party libraries `. Table of Contents ----------------- .. toctree:: - :maxdepth: 2 + :maxdepth: 3 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 .. _`Django MongoDB Backend documentation`: https://www.mongodb.com/docs/languages/python/django-mongodb/v5.1/ +.. _`Django projects`: https://docs.djangoproject.com/en/5.2/intro/tutorial01/#creating-a-project diff --git a/docs/source/installation/index.rst b/docs/source/installation/index.rst index df2842d..94ae519 100644 --- a/docs/source/installation/index.rst +++ b/docs/source/installation/index.rst @@ -26,8 +26,8 @@ Install CLI python -m pip install -e . -Install development dependencies --------------------------------- +Clone third-party library repositories +-------------------------------------- :: diff --git a/docs/source/supported-libraries/django-allauth.rst b/docs/source/supported-libraries/django-allauth.rst deleted file mode 100644 index 4622a48..0000000 --- a/docs/source/supported-libraries/django-allauth.rst +++ /dev/null @@ -1,220 +0,0 @@ -Django allauth -============== - -.. _django-allauth-results: - -Test suite ----------- - -Results -~~~~~~~ - -Via ``dm repo test django-filter`` - -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ -| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ -| 63% | 1621 | 1023 | 584 | 1 | 13 | 0 | 21 | -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ - -- `django-filter.txt <../_static/django-filter.txt>`_ - -Settings -~~~~~~~~ - -Via ``dm repo test django-filter --show`` - -:: - - { - "apps_file": { - "source": "config/allauth/allauth_apps.py", - "target": "src/django-allauth/allauth/mongo_apps.py", - }, - "clone_dir": "src/django-allauth", - "migrations_dir": { - "source": "src/django-mongodb-project/mongo_migrations", - "target": "src/django-allauth/allauth/mongo_migrations", - }, - "settings": { - "test": { - "source": "config/allauth/allauth_settings.py", - "target": "src/django-allauth/allauth/mongo_settings.py", - }, - "migrations": { - "source": "config/allauth/allauth_settings.py", - "target": "src/django-allauth/allauth/mongo_settings.py", - }, - "module": { - "test": "allauth.mongo_settings", - "migrations": "allauth.mongo_settings", - }, - }, - "test_command": "pytest", - "test_dir": "src/django-allauth", - "test_dirs": [ - "src/django-allauth/allauth/usersessions/tests", - "src/django-allauth/allauth/core/tests", - "src/django-allauth/allauth/core/internal/tests", - "src/django-allauth/allauth/tests", - "src/django-allauth/allauth/mfa/recovery_codes/tests", - "src/django-allauth/allauth/mfa/webauthn/tests", - "src/django-allauth/allauth/mfa/totp/tests", - "src/django-allauth/allauth/mfa/base/tests", - "src/django-allauth/allauth/socialaccount/providers/oauth2/tests", - "src/django-allauth/allauth/socialaccount/tests", - "src/django-allauth/allauth/socialaccount/internal/tests", - "src/django-allauth/allauth/templates/tests", - "src/django-allauth/allauth/headless/usersessions/tests", - "src/django-allauth/allauth/headless/tests", - "src/django-allauth/allauth/headless/spec/tests", - "src/django-allauth/allauth/headless/internal/tests", - "src/django-allauth/allauth/headless/mfa/tests", - "src/django-allauth/allauth/headless/socialaccount/tests", - "src/django-allauth/allauth/headless/contrib/ninja/tests", - "src/django-allauth/allauth/headless/contrib/rest_framework/tests", - "src/django-allauth/allauth/headless/account/tests", - "src/django-allauth/allauth/headless/base/tests", - "src/django-allauth/allauth/account/tests", - "src/django-allauth/tests", - ], - } - -Tests -~~~~~ - -Via ``dm repo test django-filter -l`` - -:: - - src/django-allauth/allauth/usersessions/tests - ├── test_middleware.py - └── test_views.py - - src/django-allauth/allauth/core/tests - └── test_ratelimit.py - - src/django-allauth/allauth/core/internal/tests - ├── test_httpkit.py - └── test_modelkit.py - - src/django-allauth/allauth/tests - └── test_utils.py - - src/django-allauth/allauth/mfa/recovery_codes/tests - ├── test_auth.py - └── test_views.py - - src/django-allauth/allauth/mfa/webauthn/tests - └── test_views.py - - src/django-allauth/allauth/mfa/totp/tests - ├── test_unit.py - └── test_views.py - - src/django-allauth/allauth/mfa/base/tests - ├── test_trust.py - ├── test_trust_fingerprint.py - └── test_views.py - - src/django-allauth/allauth/socialaccount/providers/oauth2/tests - └── test_views.py - - src/django-allauth/allauth/socialaccount/tests - ├── conftest.py - ├── test_adapter.py - ├── test_connect.py - ├── test_login.py - ├── test_registry.py - ├── test_signup.py - └── test_utils.py - - src/django-allauth/allauth/socialaccount/internal/tests - ├── test_jwtkit.py - └── test_statekit.py - - src/django-allauth/allauth/templates/tests - └── test_403_csrf.html - - src/django-allauth/allauth/headless/usersessions/tests - └── test_views.py - - src/django-allauth/allauth/headless/tests - └── test_tokens.py - - src/django-allauth/allauth/headless/spec/tests - └── test_views.py - - src/django-allauth/allauth/headless/internal/tests - └── test_authkit.py - - src/django-allauth/allauth/headless/mfa/tests - ├── test_recovery_codes.py - ├── test_totp.py - ├── test_trust.py - ├── test_views.py - └── test_webauthn.py - - src/django-allauth/allauth/headless/socialaccount/tests - ├── test_inputs.py - └── test_views.py - - src/django-allauth/allauth/headless/contrib/ninja/tests - └── test_security.py - - src/django-allauth/allauth/headless/contrib/rest_framework/tests - └── test_authentication.py - - src/django-allauth/allauth/headless/account/tests - ├── test_change_email.py - ├── test_change_password.py - ├── test_email_verification.py - ├── test_email_verification_by_code.py - ├── test_login.py - ├── test_login_by_code.py - ├── test_phone.py - ├── test_reauthentication.py - ├── test_reset_password.py - ├── test_reset_password_by_code.py - ├── test_session.py - └── test_signup.py - - src/django-allauth/allauth/headless/base/tests - └── test_views.py - - src/django-allauth/allauth/account/tests - ├── test_adapter.py - ├── test_ajax.py - ├── test_auth_backends.py - ├── test_change_email.py - ├── test_change_password.py - ├── test_commands.py - ├── test_decorators.py - ├── test_email_verification.py - ├── test_email_verification_by_code.py - ├── test_login.py - ├── test_login_by_code.py - ├── test_logout.py - ├── test_middleware.py - ├── test_models.py - ├── test_phone.py - ├── test_ratelimit.py - ├── test_reauthentication.py - ├── test_reset_password.py - ├── test_reset_password_by_code.py - ├── test_security.py - ├── test_signup.py - └── test_utils.py - - src/django-allauth/tests - ├── account_only - ├── common - ├── headless_only - ├── login_required_mw - └── regular - -Project examples ----------------- - -Known issues ------------- diff --git a/docs/source/supported-libraries/django-debug-toolbar.rst b/docs/source/supported-libraries/django-debug-toolbar.rst deleted file mode 100644 index 404080c..0000000 --- a/docs/source/supported-libraries/django-debug-toolbar.rst +++ /dev/null @@ -1,84 +0,0 @@ -Django debug toolbar -==================== - -.. _django-debug-toolbar-results: - -Results -------- - -Via ``dm repo test django-debug-toolbar`` - -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ -| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ -| 73% | 262 | 192 | 41 | 26 | 0 | 1 | 0 | -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ - -- `django-debug-toolbar.txt <../_static/django-debug-toolbar.txt>`_ - -Settings --------- - -Via ``dm repo test django-filter --show`` - -:: - - { - "apps_file": { - "source": "config/debug_toolbar/debug_toolbar_apps.py", - "target": "src/django-debug-toolbar/debug_toolbar/mongo_apps.py", - }, - "clone_dir": "src/django-debug-toolbar", - "settings": { - "test": { - "source": "config/debug_toolbar/debug_toolbar_settings.py", - "target": "src/django-debug-toolbar/debug_toolbar/mongo_settings.py", - }, - "migrations": { - "source": "config/debug_toolbar/debug_toolbar_settings.py", - "target": "src/django-debug-toolbar/debug_toolbar/mongo_settings.py", - }, - "module": { - "test": "debug_toolbar.mongo_settings", - "migrations": "debug_toolbar.mongo_settings", - }, - }, - "test_command": "pytest", - "test_dir": "src/django-debug-toolbar", - "test_dirs": ["src/django-debug-toolbar/tests"], - } - -Tests ------ - -Via ``dm repo test django-filter -l`` - -:: - - src/django-debug-toolbar/tests - ├── additional_static - ├── base.py - ├── commands - ├── context_processors.py - ├── forms.py - ├── loaders.py - ├── middleware.py - ├── models.py - ├── panels - ├── settings.py - ├── sync.py - ├── templates - ├── test_checks.py - ├── test_csp_rendering.py - ├── test_decorators.py - ├── test_forms.py - ├── test_integration.py - ├── test_integration_async.py - ├── test_login_not_required.py - ├── test_middleware.py - ├── test_toolbar.py - ├── test_utils.py - ├── urls.py - ├── urls_invalid.py - ├── urls_use_package_urls.py - └── views.py diff --git a/docs/source/supported-libraries/django-filter.rst b/docs/source/supported-libraries/django-filter.rst deleted file mode 100644 index 394d4d6..0000000 --- a/docs/source/supported-libraries/django-filter.rst +++ /dev/null @@ -1,78 +0,0 @@ -Django filter -============= - -Results -------- - -.. _django-filter-results: - -Via ``dm repo test django-filter`` - -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ -| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ -| 93% | 515 | 480 | 1 | 16 | 15 | 3 | 0 | -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ - -- `django-filter.txt <../_static/django-filter.txt>`_ - -Settings --------- - -Via ``dm repo test django-filter --show`` - -:: - - { - "apps_file": { - "source": "settings/filter_apps.py", - "target": "src/django-filter/tests/mongo_apps.py", - }, - "clone_dir": "src/django-filter", - "migrations_dir": { - "source": "src/django-mongodb-templates/project_template/mongo_migrations", - "target": "src/django-filter/tests/mongo_migrations", - }, - "settings": { - "test": { - "source": "settings/filter_settings.py", - "target": "src/django-filter/tests/settings.py", - }, - "migrations": { - "source": "settings/filter_settings.py", - "target": "src/django-filter/tests/settings.py", - }, - "module": {"test": "tests.settings", "migrations": "tests.settings"}, - }, - "test_command": "./runtests.py", - "test_dir": "src/django-filter", - "test_dirs": ["src/django-filter/tests"], - } - - -Tests ------ - -Via ``dm repo test django-filter -l`` - - -:: - - src/django-filter/tests - ├── models.py - ├── mongo_apps.py - ├── mongo_migrations - ├── rest_framework - ├── settings.py - ├── templates - ├── test_conf.py - ├── test_fields.py - ├── test_filtering.py - ├── test_filters.py - ├── test_filterset.py - ├── test_forms.py - ├── test_utils.py - ├── test_views.py - ├── test_widgets.py - ├── urls.py - └── utils.py diff --git a/docs/source/supported-libraries/django-rest-framework.rst b/docs/source/supported-libraries/django-rest-framework.rst deleted file mode 100644 index 2575432..0000000 --- a/docs/source/supported-libraries/django-rest-framework.rst +++ /dev/null @@ -1,122 +0,0 @@ -Django rest framework -===================== - -.. _django-rest-framework-results: - -Results -------- - -Via ``dm repo test django-rest-framework`` - -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ -| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ -| 81% | 1558 | 1276 | 146 | 136 | 0 | 0 | 4 | -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ - -- `django-rest-framework.txt <../_static/django-rest-framework.txt>`_ - -Settings --------- - -Via ``dm repo test django-rest-framework --show`` - -:: - - { - "apps_file": { - "source": "config/rest_framework/rest_framework_apps.py", - "target": "src/django-rest-framework/tests/mongo_apps.py", - }, - "clone_dir": "src/django-rest-framework", - "migrations_dir": { - "source": "src/rest_framework/django-mongodb-project/mongo_migrations", - "target": "src/django-rest-framework/tests/mongo_migrations", - }, - "settings": { - "test": { - "source": "config/rest_framework/rest_framework_settings.py", - "target": "src/django-rest-framework/tests/conftest.py", - }, - "migrations": { - "source": "config/rest_framework/rest_framework_migrate.py", - "target": "src/django-rest-framework/tests/conftest.py", - }, - "module": {"test": "tests.conftest", "migrations": "tests.conftest"}, - }, - "test_command": "./runtests.py", - "test_dir": "src/django-rest-framework", - "test_dirs": ["src/django-rest-framework/tests"], - } - -Tests ------ - -Via ``dm repo test django-filter -l`` - -:: - - src/django-rest-framework/tests - ├── authentication - ├── browsable_api - ├── conftest.py - ├── generic_relations - ├── importable - ├── models.py - ├── mongo_apps.py - ├── mongo_migrations - ├── schemas - ├── test_api_client.py - ├── test_atomic_requests.py - ├── test_authtoken.py - ├── test_bound_fields.py - ├── test_decorators.py - ├── test_description.py - ├── test_encoders.py - ├── test_exceptions.py - ├── test_fields.py - ├── test_filters.py - ├── test_generics.py - ├── test_htmlrenderer.py - ├── test_lazy_hyperlinks.py - ├── test_metadata.py - ├── test_middleware.py - ├── test_model_serializer.py - ├── test_multitable_inheritance.py - ├── test_negotiation.py - ├── test_one_to_one_with_inheritance.py - ├── test_pagination.py - ├── test_parsers.py - ├── test_permissions.py - ├── test_prefetch_related.py - ├── test_relations.py - ├── test_relations_hyperlink.py - ├── test_relations_pk.py - ├── test_relations_slug.py - ├── test_renderers.py - ├── test_request.py - ├── test_requests_client.py - ├── test_response.py - ├── test_reverse.py - ├── test_routers.py - ├── test_serializer.py - ├── test_serializer_bulk_update.py - ├── test_serializer_lists.py - ├── test_serializer_nested.py - ├── test_settings.py - ├── test_status.py - ├── test_templates.py - ├── test_templatetags.py - ├── test_testing.py - ├── test_throttling.py - ├── test_urlpatterns.py - ├── test_utils.py - ├── test_validation.py - ├── test_validation_error.py - ├── test_validators.py - ├── test_versioning.py - ├── test_views.py - ├── test_viewsets.py - ├── test_write_only_fields.py - ├── urls.py - └── utils.py diff --git a/docs/source/supported-libraries/wagtail.rst b/docs/source/supported-libraries/wagtail.rst deleted file mode 100644 index 4a0b76f..0000000 --- a/docs/source/supported-libraries/wagtail.rst +++ /dev/null @@ -1,136 +0,0 @@ -Wagtail -======= - -.. _wagtail-results: - -Results -------- - -Via ``dm repo test wagtail`` - -.. note:: - - Test results prior to merging https://github.com/mongodb/django-mongodb-backend/pull/256 - -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ -| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ -| 43% | 4897 | 2124 | 52 | 468 | 2252 | 1 | 0 | -+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ - -- `wagtail.txt <../_static/wagtail.txt>`_ -- `wagtail2.txt <../_static/wagtail2.txt>`_ - -Settings --------- - -Via ``dm repo test wagtail --show`` - -:: - - { - "apps_file": { - "source": "config/wagtail/wagtail_apps.py", - "target": "src/wagtail/wagtail/test/mongo_apps.py", - }, - "clone_dir": "src/wagtail", - "migrations_dir": { - "source": "src/django-mongodb-templates/project_template/mongo_migrations", - "target": "src/wagtail/wagtail/test/mongo_migrations", - }, - "settings": { - "test": { - "source": "config/wagtail/wagtail_settings.py", - "target": "src/wagtail/wagtail/test/mongo_settings.py", - }, - "migrations": { - "source": "config/wagtail/settings_wagtail.py", - "target": "src/wagtail/wagtail/test/mongo_settings.py", - }, - "module": { - "test": "wagtail.test.mongo_settings", - "migrations": "wagtail.test.mongo_settings", - }, - }, - "test_command": "./runtests.py", - "test_dir": "src/wagtail", - "test_dirs": ["src/wagtail/wagtail/tests", "src/wagtail/wagtail/test"], - } - -Tests ------ - -Via ``dm repo test wagtail -l`` - -:: - - src/wagtail/wagtail/tests - ├── streamfield_migrations - ├── test-media - ├── test_audit_log.py - ├── test_blocks.py - ├── test_collection_model.py - ├── test_collection_permission_policies.py - ├── test_comments.py - ├── test_draft_model.py - ├── test_form_data_utils.py - ├── test_hooks.py - ├── test_jinja2.py - ├── test_locale_model.py - ├── test_lockable_model.py - ├── test_management_commands.py - ├── test_migrations.py - ├── test_page_allowed_http_methods.py - ├── test_page_assertions.py - ├── test_page_model.py - ├── test_page_permission_policies.py - ├── test_page_permissions.py - ├── test_page_privacy.py - ├── test_page_queryset.py - ├── test_permission_policies.py - ├── test_reference_index.py - ├── test_revision_model.py - ├── test_rich_text.py - ├── test_signals.py - ├── test_sites.py - ├── test_streamfield.py - ├── test_telepath.py - ├── test_tests.py - ├── test_translatablemixin.py - ├── test_utils.py - ├── test_views.py - ├── test_whitelist.py - ├── test_workflow.py - ├── test_workflow_model.py - └── tests.py - - src/wagtail/wagtail/test - ├── .gitignore - ├── benchmark.py - ├── context_processors.py - ├── customuser - ├── demosite - ├── dummy_external_storage.py - ├── dummy_sendfile_backend.py - ├── earlypage - ├── emailuser - ├── headless_urls.py - ├── i18n - ├── manage.py - ├── middleware.py - ├── mongo_apps.py - ├── mongo_migrations - ├── mongo_settings.py - ├── non_root_urls.py - ├── numberformat.py - ├── routablepage - ├── search - ├── settings.py - ├── settings_ui.py - ├── snippets - ├── streamfield_migrations - ├── testapp - ├── urls.py - ├── urls_multilang.py - ├── urls_multilang_non_root.py - └── utils diff --git a/docs/source/third-party-library-support/index.rst b/docs/source/third-party-library-support/index.rst index 7bdd9dc..52e92ba 100644 --- a/docs/source/third-party-library-support/index.rst +++ b/docs/source/third-party-library-support/index.rst @@ -9,9 +9,16 @@ 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 + + +Suported Libraries +------------------ + +.. toctree:: + supported-libraries/index diff --git a/docs/source/third-party-library-support/supported-libraries/django-allauth.rst b/docs/source/third-party-library-support/supported-libraries/django-allauth.rst new file mode 100644 index 0000000..dcab18a --- /dev/null +++ b/docs/source/third-party-library-support/supported-libraries/django-allauth.rst @@ -0,0 +1,23 @@ +Django allauth +============== + +.. _django-allauth-results: + +Test suite +---------- + +Via ``dm repo test django-filter`` + ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| 63% | 1621 | 1023 | 584 | 1 | 13 | 0 | 21 | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ + +- `django-filter.txt <../_static/django-filter.txt>`_ + +Project examples +---------------- + +Known issues +------------ diff --git a/docs/source/third-party-library-support/supported-libraries/django-debug-toolbar.rst b/docs/source/third-party-library-support/supported-libraries/django-debug-toolbar.rst new file mode 100644 index 0000000..dbdbeb0 --- /dev/null +++ b/docs/source/third-party-library-support/supported-libraries/django-debug-toolbar.rst @@ -0,0 +1,23 @@ +Django debug toolbar +==================== + +.. _django-debug-toolbar-results: + +Test suite +---------- + +Via ``dm repo test django-debug-toolbar`` + ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| 73% | 262 | 192 | 41 | 26 | 0 | 1 | 0 | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ + +- `django-debug-toolbar.txt <../_static/django-debug-toolbar.txt>`_ + +Project examples +---------------- + +Known issues +------------ diff --git a/docs/source/third-party-library-support/supported-libraries/django-filter.rst b/docs/source/third-party-library-support/supported-libraries/django-filter.rst new file mode 100644 index 0000000..594b079 --- /dev/null +++ b/docs/source/third-party-library-support/supported-libraries/django-filter.rst @@ -0,0 +1,23 @@ +Django filter +============= + +Test suite +---------- + +.. _django-filter-results: + +Via ``dm repo test django-filter`` + ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| 93% | 515 | 480 | 1 | 16 | 15 | 3 | 0 | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ + +- `django-filter.txt <../_static/django-filter.txt>`_ + +Project examples +---------------- + +Known issues +------------ diff --git a/docs/source/third-party-library-support/supported-libraries/django-rest-framework.rst b/docs/source/third-party-library-support/supported-libraries/django-rest-framework.rst new file mode 100644 index 0000000..80b33f3 --- /dev/null +++ b/docs/source/third-party-library-support/supported-libraries/django-rest-framework.rst @@ -0,0 +1,23 @@ +Django rest framework +===================== + +.. _django-rest-framework-results: + +Test suite +---------- + +Via ``dm repo test django-rest-framework`` + ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| 81% | 1558 | 1276 | 146 | 136 | 0 | 0 | 4 | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ + +- `django-rest-framework.txt <../_static/django-rest-framework.txt>`_ + +Project examples +---------------- + +Known issues +------------ diff --git a/docs/source/supported-libraries/index.rst b/docs/source/third-party-library-support/supported-libraries/index.rst similarity index 98% rename from docs/source/supported-libraries/index.rst rename to docs/source/third-party-library-support/supported-libraries/index.rst index ecc849b..00d81dd 100644 --- a/docs/source/supported-libraries/index.rst +++ b/docs/source/third-party-library-support/supported-libraries/index.rst @@ -1,12 +1,6 @@ .. _third-party-libraries: -Supported libraries -=================== - -Overview --------- - | +------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ @@ -33,9 +27,6 @@ Overview | | | | | | +------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ -Criteria --------- - .. toctree:: django-allauth django-debug-toolbar diff --git a/docs/source/third-party-library-support/supported-libraries/wagtail.rst b/docs/source/third-party-library-support/supported-libraries/wagtail.rst new file mode 100644 index 0000000..f85f1b0 --- /dev/null +++ b/docs/source/third-party-library-support/supported-libraries/wagtail.rst @@ -0,0 +1,28 @@ +Wagtail +======= + +.. _wagtail-results: + +Test suite +---------- + +Via ``dm repo test wagtail`` + +.. note:: + + Test results prior to merging https://github.com/mongodb/django-mongodb-backend/pull/256 + ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| 43% | 4897 | 2124 | 52 | 468 | 2252 | 1 | 0 | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ + +- `wagtail.txt <../_static/wagtail.txt>`_ +- `wagtail2.txt <../_static/wagtail2.txt>`_ + +Project examples +---------------- + +Known issues +------------ diff --git a/justfile b/justfile index cebb795..ee63d3f 100644 --- a/justfile +++ b/justfile @@ -92,7 +92,8 @@ alias b := sphinx-build [group('sphinx')] sphinx-serve: - cd docs/_build && python -m http.server + # cd docs/_build && python -m http.server + sphinx-autobuild docs/source docs/_build alias ss := sphinx-serve [group('sphinx')] diff --git a/pyproject.toml b/pyproject.toml index ff37924..7720e0c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,6 +25,7 @@ dependencies = [ "requests-oauthlib", # For django-allauth "rich", "setuptools", # For django-rest-framework + "sphinx-autobuild", # For django-mongodb-backend documentation "toml", ]