]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
add collections module to API ref for completeness. links to the mapper documentation
authorMike Bayer <mike_mp@zzzcomputing.com>
Sat, 21 Mar 2009 18:03:47 +0000 (18:03 +0000)
committerMike Bayer <mike_mp@zzzcomputing.com>
Sat, 21 Mar 2009 18:03:47 +0000 (18:03 +0000)
which is less wordy.

doc/build/Makefile
doc/build/mappers.rst
doc/build/reference/orm/collections.rst [new file with mode: 0644]
doc/build/reference/orm/index.rst

index f7ac2ca576dd349387c7f3a072660e9a8358a546..6dcd0321ee953ac3f58c0fea78b8ad1d1c8368e2 100644 (file)
@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
+SPHINXBUILD   = ./bin/sphinx-build
 PAPER         =
 
 # Internal variables.
index 89db6a0a740e79b6aaf914aa9e031c81f98ec7a7..ff9b1f95bf327c19dbabe648d498bb5daabf20df 100644 (file)
@@ -1285,6 +1285,8 @@ Theres no restriction on how many times you can relate from parent to child.  SQ
                     addresses_table.c.city=='New York')),
     })
 
+.. _alternate_collection_implementations:
+
 Alternate Collection Implementations 
 -------------------------------------
 
diff --git a/doc/build/reference/orm/collections.rst b/doc/build/reference/orm/collections.rst
new file mode 100644 (file)
index 0000000..e8cf678
--- /dev/null
@@ -0,0 +1,17 @@
+Collection Mapping
+==================
+
+This is an in-depth discussion of collection mechanics.  For simple examples, see :ref:`alternate_collection_implementations`.
+
+.. automodule:: sqlalchemy.orm.collections
+
+.. autofunction:: attribute_mapped_collection
+
+.. autoclass:: collection
+
+.. autofunction:: collection_adapter
+
+.. autofunction:: column_mapped_collection
+
+.. autofunction:: mapped_collection
+
index c7c771d8cd79d4b44b95279c10f40f094a9e52ae..001d7b4eebd7d12c3047b712e159da3fa0d3d3c0 100644 (file)
@@ -7,6 +7,7 @@ sqlalchemy.orm
     :glob:
 
     mapping
+    collections
     query
     sessions
     interfaces