From 0bb1e1b8e353127b90077ff8a7b9476028f30dc7 Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Sat, 21 Mar 2009 18:03:47 +0000 Subject: [PATCH] add collections module to API ref for completeness. links to the mapper documentation which is less wordy. --- doc/build/Makefile | 2 +- doc/build/mappers.rst | 2 ++ doc/build/reference/orm/collections.rst | 17 +++++++++++++++++ doc/build/reference/orm/index.rst | 1 + 4 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 doc/build/reference/orm/collections.rst diff --git a/doc/build/Makefile b/doc/build/Makefile index f7ac2ca576..6dcd0321ee 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 89db6a0a74..ff9b1f95bf 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 0000000000..e8cf67884c --- /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 c7c771d8cd..001d7b4eeb 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 -- 2.47.3