Skip to content

Commit 1aa57dd

Browse files
aclark4lifeaclark4life
authored
Merge pull request #13 from aclark4life/main
Update docs
2 parents 9744000 + 1c41b1b commit 1aa57dd

File tree

12 files changed

+95
-69
lines changed

12 files changed

+95
-69
lines changed

‎config/extensions/debug_toolbar_settings.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@
2424
# Application definition
2525

2626
INSTALLED_APPS = [
27-
"django_mongodb_extensions.debug_toolbar.mongo_apps.MongoAdminConfig",
28-
"django_mongodb_extensions.debug_toolbar.mongo_apps.MongoAuthConfig",
29-
"django_mongodb_extensions.debug_toolbar.mongo_apps.MongoContentTypesConfig",
27+
"django_mongodb_extensions.mongo_apps.MongoAdminConfig",
28+
"django_mongodb_extensions.mongo_apps.MongoAuthConfig",
29+
"django_mongodb_extensions.mongo_apps.MongoContentTypesConfig",
3030
"django.contrib.sessions",
3131
"django.contrib.messages",
3232
"django.contrib.staticfiles",

‎docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Table of Contents
2121
:maxdepth: 2
2222

2323
installation/index
24-
third-party-library-support
24+
third-party-library-support/index
2525
supported-libraries/index
2626

2727
.. _`Django MongoDB Backend`: https://github.com/mongodb/django-mongodb-backend

‎docs/source/installation/clone-repository.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎docs/source/installation/index.rst

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,51 @@
11
Installation
22
============
33

4+
Clone the repository
5+
--------------------
46

5-
.. toctree::
6-
clone-repository
7-
venv
8-
usage
7+
::
8+
9+
git clone https://github.com/mongodb-labs/django-mongodb-cli
10+
cd django-mongodb-cli
11+
12+
13+
Create a virtual environment
14+
----------------------------
15+
16+
::
17+
18+
python -m venv .venv
19+
source .venv/bin/activate
20+
21+
22+
Install CLI
23+
-----------
24+
25+
::
26+
27+
python -m pip install -e .
28+
29+
Install development dependencies
30+
--------------------------------
31+
32+
::
33+
34+
dm repo clone -a
35+
36+
Usage
37+
-----
38+
39+
.. code:: bash
40+
41+
$ dm --help
42+
Usage: dm [OPTIONS] COMMAND [ARGS]...
43+
44+
Django MongoDB CLI
45+
46+
Options:
47+
--help Show this message and exit.
48+
49+
Commands:
50+
repo Run Django fork and third-party library tests.
51+
startproject Run `startproject` with custom templates.

‎docs/source/installation/usage.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎docs/source/installation/venv.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎docs/source/supported-libraries/django-allauth.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,11 @@ Django allauth
33

44
.. _django-allauth-results:
55

6+
Test suite
7+
----------
8+
69
Results
7-
-------
10+
~~~~~~~
811

912
Via ``dm repo test django-filter``
1013

@@ -17,7 +20,7 @@ Via ``dm repo test django-filter``
1720
- `django-filter.txt <../_static/django-filter.txt>`_
1821

1922
Settings
20-
--------
23+
~~~~~~~~
2124

2225
Via ``dm repo test django-filter --show``
2326

@@ -78,7 +81,7 @@ Via ``dm repo test django-filter --show``
7881
}
7982

8083
Tests
81-
-----
84+
~~~~~
8285

8386
Via ``dm repo test django-filter -l``
8487

@@ -209,3 +212,9 @@ Via ``dm repo test django-filter -l``
209212
├── headless_only
210213
├── login_required_mw
211214
└── regular
215+
216+
Project examples
217+
----------------
218+
219+
Known issues
220+
------------

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,13 @@
44
Supported libraries
55
===================
66

7+
Overview
8+
--------
9+
710
|
811
912
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
10-
| **Library** | **Test suites** | **Project examples** | **Known limitations** | **Notes** |
13+
| **Library** | **Test suites** | **Project examples** | **Known issues** | **Notes** |
1114
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
1215
| **django-allauth** | :ref:`63% passing <django-allauth-results>` | | | |
1316
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
@@ -30,6 +33,9 @@ Supported libraries
3033
| | | | | |
3134
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
3235

36+
Criteria
37+
--------
38+
3339
.. toctree::
3440
django-allauth
3541
django-debug-toolbar

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Third party library support
2+
===========================
3+
4+
Definition
5+
-----------
6+
7+
This is the criteria used to determine if a third party library is supported
8+
by Django MongoDB Backend. It is not a guarantee that the library will
9+
work without issues, just that these criteria have been met.
10+
11+
Criteria
12+
--------
13+
14+
.. toctree::
15+
test-suites
16+
project-examples
17+
known-issues

‎docs/source/third-party-library-support/known-issues.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. _`known_issues`:
2+
3+
Known issues
4+
------------

0 commit comments

Comments
 (0)