summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2009-03-21 18:03:47 +0000
committerMike Bayer <mike_mp@zzzcomputing.com>2009-03-21 18:03:47 +0000
commit0bb1e1b8e353127b90077ff8a7b9476028f30dc7 (patch)
tree620250f9987d2ffd028d3f372ea7544956c1ab6b /doc
parent0983b610b47d2cbe502837ded365a2d2dbcdc883 (diff)
downloadsqlalchemy-0bb1e1b8e353127b90077ff8a7b9476028f30dc7.tar.gz
add collections module to API ref for completeness. links to the mapper documentation
which is less wordy.
Diffstat (limited to 'doc')
-rw-r--r--doc/build/Makefile2
-rw-r--r--doc/build/mappers.rst2
-rw-r--r--doc/build/reference/orm/collections.rst17
-rw-r--r--doc/build/reference/orm/index.rst1
4 files changed, 21 insertions, 1 deletions
diff --git a/doc/build/Makefile b/doc/build/Makefile
index f7ac2ca57..6dcd0321e 100644
--- a/doc/build/Makefile
+++ b/doc/build/Makefile
@@ -3,7 +3,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
-SPHINXBUILD = sphinx-build
+SPHINXBUILD = ./bin/sphinx-build
PAPER =
# Internal variables.
diff --git a/doc/build/mappers.rst b/doc/build/mappers.rst
index 89db6a0a7..ff9b1f95b 100644
--- a/doc/build/mappers.rst
+++ b/doc/build/mappers.rst
@@ -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
index 000000000..e8cf67884
--- /dev/null
+++ b/doc/build/reference/orm/collections.rst
@@ -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
+
diff --git a/doc/build/reference/orm/index.rst b/doc/build/reference/orm/index.rst
index c7c771d8c..001d7b4ee 100644
--- a/doc/build/reference/orm/index.rst
+++ b/doc/build/reference/orm/index.rst
@@ -7,6 +7,7 @@ sqlalchemy.orm
:glob:
mapping
+ collections
query
sessions
interfaces