-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
263 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
Admin | ||
===== | ||
|
||
.. module:: dockit.admin | ||
|
||
|
||
Dockit provides some basic admin functionality for documents. Additionally the admin allows for editing of nested schemas in your document and also allows for customization on a per schema basis (TODO document this). | ||
|
||
DocumentAdmin | ||
------------- | ||
|
||
TODO | ||
|
||
|
||
SchemaAdmin | ||
----------- | ||
|
||
TODO | ||
|
||
|
||
InlineSchemaAdmin | ||
----------------- | ||
|
||
* StackedInline | ||
* TabularInline | ||
|
||
TODO | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Backends | ||
======== | ||
|
||
.. module:: dockit.backends | ||
|
||
Base Backend | ||
------------ | ||
|
||
TODO | ||
|
||
Mongo Backend | ||
------------- | ||
|
||
TODO | ||
|
||
Django Document Backend | ||
----------------------- | ||
|
||
Recommended for dev and testing purposes only. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,182 @@ | ||
====================== | ||
Schema Field Reference | ||
====================== | ||
|
||
.. module:: dockit.schema.fields | ||
:synopsis: Built-in field types. | ||
|
||
|
||
``CharField`` | ||
------------- | ||
|
||
.. class:: CharField | ||
|
||
TODO | ||
|
||
|
||
``TextField`` | ||
------------- | ||
|
||
.. class:: TextField | ||
|
||
TODO | ||
|
||
|
||
``IntegerField`` | ||
---------------- | ||
|
||
.. class:: IntegerField | ||
|
||
TODO | ||
|
||
|
||
``BigIntegerField`` | ||
------------------- | ||
|
||
.. class:: BigIntegerField | ||
|
||
TODO | ||
|
||
|
||
``BooleanField`` | ||
---------------- | ||
|
||
.. class:: BooleanField | ||
|
||
TODO | ||
|
||
|
||
``DateField`` | ||
------------- | ||
|
||
.. class:: DateField | ||
|
||
TODO | ||
|
||
|
||
``DateTimeField`` | ||
----------------- | ||
|
||
.. class:: DateTimeField | ||
|
||
TODO | ||
|
||
|
||
``DecimalField`` | ||
---------------- | ||
|
||
.. class:: DecimalField | ||
|
||
TODO | ||
|
||
|
||
``EmailField`` | ||
-------------- | ||
|
||
.. class:: EmailField | ||
|
||
TODO | ||
|
||
|
||
``FloatField`` | ||
-------------- | ||
|
||
.. class:: FloatField | ||
|
||
TODO | ||
|
||
``IPAddressField`` | ||
------------------ | ||
|
||
.. class:: IPAddressField | ||
|
||
TODO | ||
|
||
``PositiveIntegerField`` | ||
------------------------ | ||
|
||
.. class:: PositiveInteferField | ||
|
||
TODO | ||
|
||
|
||
``SlugField`` | ||
------------- | ||
|
||
.. class:: SlugField | ||
|
||
TODO | ||
|
||
``TimeField`` | ||
------------- | ||
|
||
.. class:: TimeField | ||
|
||
TODO | ||
|
||
``SchemaTypeField`` | ||
------------------- | ||
|
||
.. class:: SchemaTypeField | ||
|
||
TODO | ||
|
||
|
||
``SchemaField`` | ||
--------------- | ||
|
||
.. class:: SchemaField | ||
|
||
TODO | ||
|
||
|
||
``GenericSchemaField`` | ||
---------------------- | ||
|
||
.. class:: GenericSchemaField | ||
|
||
TODO | ||
|
||
``TypedSchemaField`` | ||
-------------------- | ||
|
||
.. class:: TypedSchemaField | ||
|
||
TODO | ||
|
||
``ListField`` | ||
------------- | ||
|
||
.. class:: ListField | ||
|
||
TODO | ||
|
||
``DictField`` | ||
------------- | ||
|
||
.. class:: DictField | ||
|
||
TODO | ||
|
||
``ReferenceField`` | ||
------------------ | ||
|
||
.. class:: ReferenceField | ||
|
||
TODO | ||
|
||
|
||
``ModelReferenceField`` | ||
----------------------- | ||
|
||
.. class:: ModelReferenceField | ||
|
||
TODO | ||
|
||
``FileField`` | ||
------------- | ||
|
||
.. class:: FileField | ||
|
||
TODO | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Forms | ||
===== | ||
|
||
.. module:: dockit.forms | ||
|
||
Dockit provides and ModelForm like class ``DocumentForm``. | ||
|
||
------------ | ||
DocumentForm | ||
------------ | ||
|
||
TODO | ||
|
||
Meta Options | ||
------------ | ||
|
||
# document | ||
# schema | ||
# dotpath | ||
# exclude | ||
|
||
TODO document the other options |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
Schemas | ||
======= | ||
|
||
.. module:: dockit.schemas | ||
.. module:: dockit.schema.schema | ||
|
||
The Schema Class | ||
---------------- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Views | ||
===== | ||
|
||
Dockit provides all the generic class based views that django provides but re-tooled for documents. | ||
|
||
TODO |