summaryrefslogtreecommitdiff
path: root/doc/build/lib/docstring.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2006-10-21 20:57:10 +0000
committerMike Bayer <mike_mp@zzzcomputing.com>2006-10-21 20:57:10 +0000
commit8657f3bb9b6d9e6a005994ebdc191ec49e4fb65c (patch)
tree11aa3b85fdbf643265d8ac368af8e1c133ccbf1d /doc/build/lib/docstring.py
parentf2b58b79777dc3e671ae1d2f20033d29c66dbe04 (diff)
downloadsqlalchemy-8657f3bb9b6d9e6a005994ebdc191ec49e4fb65c.tar.gz
merge of new documentation generation system
Diffstat (limited to 'doc/build/lib/docstring.py')
-rw-r--r--doc/build/lib/docstring.py7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/build/lib/docstring.py b/doc/build/lib/docstring.py
index b6879c7ad..b4ddcff4e 100644
--- a/doc/build/lib/docstring.py
+++ b/doc/build/lib/docstring.py
@@ -1,6 +1,8 @@
-import re, types, string, inspect
+"""
+defines a pickleable, recursive "generated python documentation" datastructure.
+"""
-"""sucks a module and its contents into a simple documentation object, suitable for pickling"""
+import re, types, string, inspect
allobjects = {}
@@ -9,6 +11,7 @@ class AbstractDoc(object):
allobjects[id(obj)] = self
self.id = id(obj)
self.allobjects = allobjects
+ self.toc_path = None
class ObjectDoc(AbstractDoc):
def __init__(self, obj, functions=None, classes=None):