diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2006-10-17 02:03:00 +0000 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2006-10-17 02:03:00 +0000 |
commit | 180d3741997c1471b9199334d6076e45cd581d62 (patch) | |
tree | de7b56896d440e375a10df1440f6cccec11047cc /doc/build/compile_docstrings.py | |
parent | bc698d778d9bc8ddf2ee676fde24326f819da7dc (diff) | |
download | sqlalchemy-180d3741997c1471b9199334d6076e45cd581d62.tar.gz |
reorganizing classnames a bit, flagging "private" classes in the sql package,
getting the generated docs to look a little nicer.
fixes to extensions, sqlsoup etc. to be compatible with recent API tweaks
Diffstat (limited to 'doc/build/compile_docstrings.py')
-rw-r--r-- | doc/build/compile_docstrings.py | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/build/compile_docstrings.py b/doc/build/compile_docstrings.py index fc6003c0e..fdc3bd672 100644 --- a/doc/build/compile_docstrings.py +++ b/doc/build/compile_docstrings.py @@ -20,10 +20,12 @@ import sqlalchemy.ext.selectresults as selectresults objects = [] def make_doc(obj, classes=None, functions=None): objects.append(docstring.ObjectDoc(obj, classes=classes, functions=functions)) - -make_doc(obj=sql, classes=[]) + +# basically, if you see make_doc(obj=XXX) and thats it, we have separated out the public interface. otherwise +# still a work in progress. +make_doc(obj=sql) make_doc(obj=schema) -make_doc(obj=engine, classes=[engine.Connectable, engine.ComposedSQLEngine, engine.Connection, engine.Transaction, engine.Dialect, engine.ConnectionProvider, engine.ExecutionContext, engine.ResultProxy, engine.RowProxy]) +make_doc(obj=engine) make_doc(obj=engine.url) make_doc(obj=orm, classes=[orm.MapperExtension]) make_doc(obj=orm.mapperlib, classes=[orm.mapperlib.Mapper, orm.mapperlib.SelectionContext]) |