Skip to content
This repository has been archived by the owner on Dec 21, 2022. It is now read-only.

Commit

Permalink
docs refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
chartpath committed May 19, 2015
1 parent 87fe038 commit 01beb74
Show file tree
Hide file tree
Showing 4 changed files with 141 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/source/base_classes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Base Classes
------------

.. autoclass:: nefertari_sqla.documents.BaseMixin
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.documents.BaseDocument
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.documents.ESBaseDocument
:members:
:special-members:
:private-members:
10 changes: 10 additions & 0 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Changelog
=========

* :release:`0.2.0 <2015-04-07>`
* :feature:`-` Relationship indexing

* :release:`0.1.1 <2015-04-01>`

* :release:`0.1.0 <2015-04-01>`

102 changes: 102 additions & 0 deletions docs/source/fields.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
Fields
------

.. autoclass:: nefertari_sqla.fields.IntegerField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.BigIntegerField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.SmallIntegerField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.BooleanField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.DateField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.DateTimeField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.FloatField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.StringField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.TextField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.UnicodeField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.UnicodeTextField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.ChoiceField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.BinaryField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.DecimalField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.TimeField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.PickleField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.IntervalField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.IdField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.ForeignKeyField
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.fields.Relationship
:members:
:special-members:
:private-members:
12 changes: 12 additions & 0 deletions docs/source/serializers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Serializers
-----------

.. autoclass:: nefertari_sqla.serializers.JSONEncoder
:members:
:special-members:
:private-members:

.. autoclass:: nefertari_sqla.serializers.ESJSONSerializer
:members:
:special-members:
:private-members:

0 comments on commit 01beb74

Please sign in to comment.