summaryrefslogtreecommitdiff
path: root/doc/build/gen_docstrings.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2007-04-14 01:28:45 +0000
committerMike Bayer <mike_mp@zzzcomputing.com>2007-04-14 01:28:45 +0000
commitbb1ec10f3a6b0932d8d6aa92027b40374db9943f (patch)
tree788c0ad669d1fc34dbefe6f8753da857e7770c28 /doc/build/gen_docstrings.py
parentb9ce8e38c9a406f2b979aec133c36cc587d888c7 (diff)
downloadsqlalchemy-bb1ec10f3a6b0932d8d6aa92027b40374db9943f.tar.gz
some docstrings to provide more detail in the sql package
Diffstat (limited to 'doc/build/gen_docstrings.py')
-rw-r--r--doc/build/gen_docstrings.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/build/gen_docstrings.py b/doc/build/gen_docstrings.py
index ced16af24..c9b9df09e 100644
--- a/doc/build/gen_docstrings.py
+++ b/doc/build/gen_docstrings.py
@@ -16,16 +16,16 @@ import sqlalchemy.mods.threadlocal as threadlocal
import sqlalchemy.ext.selectresults as selectresults
import sqlalchemy.databases as databases
-def make_doc(obj, classes=None, functions=None):
+def make_doc(obj, classes=None, functions=None, **kwargs):
"""generate a docstring.ObjectDoc structure for an individual module, list of classes, and list of functions."""
- obj = docstring.ObjectDoc(obj, classes=classes, functions=functions)
+ obj = docstring.ObjectDoc(obj, classes=classes, functions=functions, **kwargs)
return (obj.name, obj)
def make_all_docs():
"""generate a docstring.AbstractDoc structure."""
print "generating docstrings"
objects = [
- make_doc(obj=sql),
+ make_doc(obj=sql,include_all_classes=True),
make_doc(obj=schema),
make_doc(obj=types),
make_doc(obj=engine),