some docstrings to provide more detail in the sql package

3 files changed, 10 insertions, 7 deletions

diff --git a/doc/build/content/docstrings.html b/doc/build/content/docstrings.html
index 1fdde37e2..c0a9e1ac2 100644
--- a/doc/build/content/docstrings.html
+++ b/doc/build/content/docstrings.html
@@ -9,3 +9,4 @@
 <%!
     filename = 'docstrings'
 %>
+
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),
diff --git a/doc/build/lib/docstring.py b/doc/build/lib/docstring.py
index d234414bd..e878aa9b2 100644
--- a/doc/build/lib/docstring.py
+++ b/doc/build/lib/docstring.py
@@ -14,15 +14,16 @@ class AbstractDoc(object):
         self.toc_path = None
         
 class ObjectDoc(AbstractDoc):
-    def __init__(self, obj, functions=None, classes=None):
+    def __init__(self, obj, functions=None, classes=None, include_all_classes=False):
         super(ObjectDoc, self).__init__(obj)
         self.isclass = isinstance(obj, types.ClassType) or isinstance(obj, types.TypeType)
         self.name= obj.__name__
+        self.include_all_classes = include_all_classes
         functions = functions
         classes= classes
         
         if not self.isclass:
-            if hasattr(obj, '__all__'):
+            if not include_all_classes and hasattr(obj, '__all__'):
                 objects = obj.__all__
                 sort = True
             else:
@@ -42,10 +43,11 @@ class ObjectDoc(AbstractDoc):
                     if getattr(obj,x,None) is not None and 
                         (isinstance(getattr(obj,x), types.TypeType) 
                         or isinstance(getattr(obj,x), types.ClassType))
-                        and not getattr(obj,x).__name__[0] == '_'
+                        and (self.include_all_classes or not getattr(obj,x).__name__[0] == '_')
                     ]
+                classes = list(set(classes))
                 if sort:
-                    classes.sort(lambda a, b: cmp(a.__name__, b.__name__))
+                    classes.sort(lambda a, b: cmp(a.__name__.replace('_', ''), b.__name__.replace('_', '')))
         else:
             if functions is None:
                 functions = (