Skip to content

Commit

Permalink
stubbed out more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zbyte64 committed Feb 9, 2012
1 parent ba4c42a commit b71f5d9
Show file tree
Hide file tree
Showing 7 changed files with 263 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ Welcome to Django Dockits's documentation!
:glob:
:maxdepth: 2

manual/admin
manual/backends
manual/schemas
manual/fields
manual/forms
manual/views
manual/indexers

Download: http://github.com/zbyte64/django-dockit
Expand Down
28 changes: 28 additions & 0 deletions docs/source/manual/admin.rst
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

19 changes: 19 additions & 0 deletions docs/source/manual/backends.rst
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.
182 changes: 182 additions & 0 deletions docs/source/manual/fields.rst
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

22 changes: 22 additions & 0 deletions docs/source/manual/forms.rst
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
2 changes: 1 addition & 1 deletion docs/source/manual/schemas.rst
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
----------------
Expand Down
6 changes: 6 additions & 0 deletions docs/source/manual/views.rst
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

0 comments on commit b71f5d9

Please sign in to comment.