summaryrefslogtreecommitdiff
path: root/doc/build/lib/docstring.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/lib/docstring.py
parentb9ce8e38c9a406f2b979aec133c36cc587d888c7 (diff)
downloadsqlalchemy-bb1ec10f3a6b0932d8d6aa92027b40374db9943f.tar.gz
some docstrings to provide more detail in the sql package
Diffstat (limited to 'doc/build/lib/docstring.py')
-rw-r--r--doc/build/lib/docstring.py10
1 files changed, 6 insertions, 4 deletions
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 = (