openstack/deb-python-sqlalchemy-utils
Code Issues Proposed changes

Restructured docs

Browse Source
This commit is contained in:
Konsta Vesterinen
2013-10-30 14:38:51 +02:00
parent d4a1354a88
commit c00eb29de3
1 changed files with 37 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
docs/index.rst
View File

@@ -488,31 +488,54 @@ Generic relationship is a form of relationship that supports creating a 1 to man
Utility functions
-----------------
.. module:: sqlalchemy_utils.functions
declarative_base
^^^^^^^^^^^^^^^^
.. autofunction:: declarative_base
escape_like
^^^^^^^^^^^
.. autofunction:: escape_like
has_changes
^^^^^^^^^^^
.. autofunction:: has_changes
identity
^^^^^^^^
.. autofunction:: identity
API Documentation
-----------------
is_indexed_foreign_key
^^^^^^^^^^^^^^^^^^^^^^
.. module:: sqlalchemy_utils
.. autoclass:: InstrumentedList
:members:
.. autofunction:: is_indexed_foreign_key
.. module:: sqlalchemy_utils.functions
naturally_equivalent
^^^^^^^^^^^^^^^^^^^^
.. autofunction:: naturally_equivalent
non_indexed_foreign_keys
^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: non_indexed_foreign_keys
sort_query
^^^^^^^^^^
.. autofunction:: sort_query
.. autofunction:: escape_like
.. autofunction:: naturally_equivalent
.. autofunction:: has_changes
.. autofunction:: non_indexed_foreign_keys
.. autofunction:: is_indexed_foreign_key
.. autofunction:: is_auto_assigned_date_column
.. autofunction:: declarative_base
License