[Checkins] SVN: grokui.introspector/trunk/src/grokui/introspector/util.py Add a docstring renderer.

[Uli Fouquet]

Log message for revision 89768:
  Add a docstring renderer.

Changed:
  U   grokui.introspector/trunk/src/grokui/introspector/util.py

-=-
Modified: grokui.introspector/trunk/src/grokui/introspector/util.py
===================================================================
--- grokui.introspector/trunk/src/grokui/introspector/util.py	2008-08-13 00:21:22 UTC (rev 89767)
+++ grokui.introspector/trunk/src/grokui/introspector/util.py	2008-08-13 00:29:42 UTC (rev 89768)
@@ -65,3 +65,21 @@
 
     renderer = getMultiAdapter((source, TestRequest()))
     return renderer.render()
+
+def render_docstring(docstring, heading_only=False):
+    """Get the doc string of the module ReST formatted.
+    """
+    if docstring is None:
+        return u''
+    lines = docstring.strip().split('\n')
+    if len(lines) and heading_only:
+        # Find first empty line to separate heading from trailing text.
+        headlines = []
+        for line in lines:
+            if line.strip() == "":
+                break
+            headlines.append(line)
+        lines = headlines
+    # Get rid of possible CVS id.
+    lines = [line for line in lines if not line.startswith('$Id')]
+    return render_text('\n'.join(lines))