happydoc-checkins — CVS and SVN Checkin messages

[Happydoc-checkins] CVS: HappyDoc3/happydoclib appclass.py,1.7,1.8

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib
In directory sc8-pr-cvs1:/tmp/cvs-serv476/happydoclib

Modified Files:
	appclass.py 
Log Message:
Ignore trace.txt file, too.


Index: appclass.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/appclass.py,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** appclass.py	1 Dec 2002 22:34:49 -0000	1.7
--- appclass.py	15 Dec 2002 16:59:10 -0000	1.8
***************
*** 125,128 ****
--- 125,129 ----
          self._ignore_dir_patterns = []
          self.addIgnoreDirectoryPattern('(CVS|dist|build|docs?|.*pyc|.*~)')
+         self.addIgnoreDirectoryPattern('trace.txt')
  
          return

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset docset_MultiHTMLFile.py,1.7,1.8 test_docset_MultiHTMLFile.py,1.5,1.6

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset
In directory sc8-pr-cvs1:/tmp/cvs-serv15399/happydoclib/docset

Modified Files:
	docset_MultiHTMLFile.py test_docset_MultiHTMLFile.py 
Log Message:
Use an anchor tag instead of just the name of the node in the
TOC list.


Index: docset_MultiHTMLFile.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/docset_MultiHTMLFile.py,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** docset_MultiHTMLFile.py	8 Dec 2002 17:02:58 -0000	1.7
--- docset_MultiHTMLFile.py	8 Dec 2002 17:19:05 -0000	1.8
***************
*** 191,196 ****
          return
  
      def _writeTOCReferencesSection(self, output, packageTreeNode, title, moduleList):
!         descriptive_list = [ (name,) + node.getSummaryAndFormat()
                               for name, node in moduleList ]
          if descriptive_list:
--- 191,219 ----
          return
  
+     def _computeRelativeHREF(self, source, destination):
+         relative_path = source.getPathToNode(destination)
+         if not relative_path:
+             return '.'
+ 
+         destination_name = destination.getName()
+         if relative_path[-1] == destination_name:
+             #
+             # Need to replace with output name.
+             #
+             output_name = self.getOutputFilenameForPackageTreeNode(
+                 destination,
+                 includePath=0,
+                 )
+             relative_path = relative_path[:-1] + (output_name,)
+ 
+         href = '/'.join(relative_path)
+         return href
+ 
+     def _getAnchorTagForPackageTreeNode(self, source, destination):
+         href = self._computeRelativeHREF(source, destination)
+         return '<a href="%s">%s</a>' % (href, destination.getName())
+ 
      def _writeTOCReferencesSection(self, output, packageTreeNode, title, moduleList):
!         descriptive_list = [ (self._getAnchorTagForPackageTreeNode(packageTreeNode, node), ) + node.getSummaryAndFormat()
                               for name, node in moduleList ]
          if descriptive_list:

Index: test_docset_MultiHTMLFile.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/test_docset_MultiHTMLFile.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** test_docset_MultiHTMLFile.py	8 Dec 2002 17:03:28 -0000	1.5
--- test_docset_MultiHTMLFile.py	8 Dec 2002 17:19:05 -0000	1.6
***************
*** 225,228 ****
--- 225,295 ----
          return
  
+ class GetHREFTestCase(unittest.TestCase):
+ 
+     def setUp(self):
+         import os
+         cwd = os.getcwd()
+         input_dir = os.path.join(cwd, 'TestCases/testScanner')
+         scanner = Scanner([input_dir])
+ 
+         trees = scanner.getPackageTrees()
+         expected_tree = trees[0]
+         self.expected_tree = expected_tree
+         
+         self.docset = MultiHTMLFileDocSet(scanner,
+                                           'Testing',
+                                           '/tmp/foo',
+                                           )
+         return
+ 
+     def testSelfHREF(self):
+         target = self.expected_tree['levelOne']['levelTwo']['two.py']
+         start = self.expected_tree['levelOne']['levelTwo']['two.py']
+ 
+         href = self.docset._computeRelativeHREF(start, target)
+         self.failUnlessEqual(href,
+                              '.',
+                              )
+         return
+     
+     def testParentDirOfModuleDirHREF(self):
+         target = self.expected_tree['levelOne']
+         start = self.expected_tree['levelOne']['levelTwo']['two.py']
+ 
+         href = self.docset._computeRelativeHREF(start, target)
+         self.failUnlessEqual(href,
+                              '..',
+                              )
+         return
+     
+     def testModuleSameDirHREF(self):
+         target = self.expected_tree['levelOne']['one.py']
+         start = self.expected_tree['levelOne']['ignoreme.py']
+ 
+         href = self.docset._computeRelativeHREF(start, target)
+         self.failUnlessEqual(href,
+                              'one.html',
+                              )
+         return
+     
+     def testModuleParentDirHREF(self):
+         target = self.expected_tree['levelOne']['one.py']
+         start = self.expected_tree['levelOne']['levelTwo']['two.py']
+ 
+         href = self.docset._computeRelativeHREF(start, target)
+         self.failUnlessEqual(href,
+                              '../one.html',
+                              )
+         return
+     
+     def testParentDirOfDirHREF(self):
+         target = self.expected_tree['levelOne']
+         start = self.expected_tree['levelOne']['levelTwo']
+ 
+         href = self.docset._computeRelativeHREF(start, target)
+         self.failUnlessEqual(href,
+                              '..',
+                              )
+         return
      
  

[Happydoc-checkins] CVS: HappyDoc3/happydoclib test_scanner.py,1.5,1.6

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib
In directory sc8-pr-cvs1:/tmp/cvs-serv15145/happydoclib

Modified Files:
	test_scanner.py 
Log Message:
Add a test for relative path from one module to another module in its
parent directory.


Index: test_scanner.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/test_scanner.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** test_scanner.py	8 Dec 2002 17:01:58 -0000	1.5
--- test_scanner.py	8 Dec 2002 17:18:31 -0000	1.6
***************
*** 320,323 ****
--- 320,335 ----
          return
      
+     def testModuleParentDir(self):
+         target = self.expected_tree['levelOne']['one.py']
+         start = self.expected_tree['levelOne']['levelTwo']['two.py']
+ 
+         relative_path = start.getPathToNode(target)
+         self.failUnlessEqual(relative_path,
+                              ('..',
+                               'one.py',
+                               ),
+                              )
+         return
+     
      def testParentDirOfDir(self):
          target = self.expected_tree['levelOne']

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset test_docset_MultiHTMLFile.py,1.4,1.5

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset
In directory sc8-pr-cvs1:/tmp/cvs-serv10771/happydoclib/docset

Modified Files:
	test_docset_MultiHTMLFile.py 
Log Message:
Moved tests to test_scanner.py, since the tested feature moved into
the PackageTreeNode.


Index: test_docset_MultiHTMLFile.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/test_docset_MultiHTMLFile.py,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** test_docset_MultiHTMLFile.py	7 Dec 2002 17:03:40 -0000	1.4
--- test_docset_MultiHTMLFile.py	8 Dec 2002 17:03:28 -0000	1.5
***************
*** 199,206 ****
          self.failUnlessEqual(actual, expected)
          return
! 
! class MultiHTMLFileDocSetREADMETestCase(unittest.TestCase):
! 
!     def setUp(self):
          input_dir = os.path.join('TestCases', 'testScanner')
          output_dir = '/tmp/foo'
--- 199,205 ----
          self.failUnlessEqual(actual, expected)
          return
!     
!     def testNoPath(self):
!                    
          input_dir = os.path.join('TestCases', 'testScanner')
          output_dir = '/tmp/foo'
***************
*** 208,211 ****
--- 207,214 ----
          scanner = Scanner([input_dir])
  
+         trees = scanner.getPackageTrees()
+         expected_tree = trees[0]
+ 
+         module_two = expected_tree['levelOne']['levelTwo']['two.py']
  
          docset = MultiHTMLFileDocSet(scanner,
***************
*** 214,260 ****
                                       )
  
!         self.scanner = scanner
!         self.docset = docset
!         return
! 
!     def tearDown(self):
!         del self.scanner
!         del self.docset
!         return
!     
!     def testGetReadmeTextForDirectoryInit(self):
!         trees = self.scanner.getPackageTrees()
!         expected_tree = trees[0]['readme_from_init']
! 
!         actual, format = self.docset._getReadmeTextForDirectory(expected_tree)
! 
!         expected_format = 'StructuredText'
!         expected = 'This is the __init__.py file for readme_from_init.'
!         
!         self.failUnlessEqual(actual, expected)
!         return
!     
!     def testGetReadmeTextForDirectoryDotTxt(self):
!         trees = self.scanner.getPackageTrees()
!         expected_tree = trees[0]['readme_from_readme']
! 
!         actual, format = self.docset._getReadmeTextForDirectory(expected_tree)
! 
!         expected_format = 'StructuredText'
!         expected = 'This is the README.txt file for readme_from_readme.\n'
!         
!         self.failUnlessEqual(actual, expected)
!         return
!     
!     def testGetReadmeTextForDirectoryDotStx(self):
!         trees = self.scanner.getPackageTrees()
!         expected_tree = trees[0]['readme_from_stx']
! 
!         actual, format = self.docset._getReadmeTextForDirectory(expected_tree)
  
!         expected_format = 'StructuredText'
!         expected = 'This is the README.stx file for readme_from_stx.\n'
!         
!         self.failUnlessEqual(actual, expected)
          return
  
--- 217,226 ----
                                       )
  
!         actual = docset.getOutputFilenameForPackageTreeNode(
!             module_two,
!             includePath=0,
!             )
  
!         self.failUnlessEqual(actual, 'two.html')
          return
  

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset docset_MultiHTMLFile.py,1.6,1.7

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset
In directory sc8-pr-cvs1:/tmp/cvs-serv10610/happydoclib/docset

Modified Files:
	docset_MultiHTMLFile.py 
Log Message:
Add optional argument includePath to
getOutputFilenameForPackageTreeNode() so we can get just the basename
of the output file.
Remove dead code.


Index: docset_MultiHTMLFile.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/docset_MultiHTMLFile.py,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** docset_MultiHTMLFile.py	8 Dec 2002 16:27:33 -0000	1.6
--- docset_MultiHTMLFile.py	8 Dec 2002 17:02:58 -0000	1.7
***************
*** 86,94 ****
      codeForegroundColor='#000088'
      
!     def getOutputFilenameForPackageTreeNode(self, packageTreeNode):
          trace.into('MultiHTMLFileDocSet', 'getOutputFilenameForPackageTreeNode')
          filename = base.MultiFileDocSet.getOutputFilenameForPackageTreeNode(
              self,
              packageTreeNode,
              )
          
--- 86,95 ----
      codeForegroundColor='#000088'
      
!     def getOutputFilenameForPackageTreeNode(self, packageTreeNode, includePath=1):
          trace.into('MultiHTMLFileDocSet', 'getOutputFilenameForPackageTreeNode')
          filename = base.MultiFileDocSet.getOutputFilenameForPackageTreeNode(
              self,
              packageTreeNode,
+             includePath=includePath,
              )
          
***************
*** 169,195 ****
          ''' % locals())
          return
- 
-     def _getReadmeTextForDirectory(self, packageTreeNode):
-         """Returns the raw README text for the directory.
- 
-         Returns first value found, in order:
- 
-           1. __init__.py docstring
- 
-           2. README.txt
- 
-           3. README.stx
-           
-         """
-         trace.into('MultiHTMLFile', '_getReadmeTextForDirectory',
-                    packageTreeNode=packageTreeNode,
-                    )
-         
-         readme_text = ''
-         text_format = 'StructuredText'
- 
-                 
-         trace.outof( (readme_text, text_format))
-         return (readme_text, text_format)
  
      def _writeDescriptiveList(self, output, descriptiveList):
--- 170,173 ----

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset base.py,1.7,1.8

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset
In directory sc8-pr-cvs1:/tmp/cvs-serv10523/happydoclib/docset

Modified Files:
	base.py 
Log Message:
Add optional argument includePath to
getOutputFilenameForPackageTreeNode() so we can get just the basename
of the output file.


Index: base.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/base.py,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** base.py	8 Dec 2002 16:23:52 -0000	1.7
--- base.py	8 Dec 2002 17:02:37 -0000	1.8
***************
*** 190,194 ****
          }
  
!     def getOutputFilenameForPackageTreeNode(self, packageTreeNode):
          """Returns a filename where documentation for packageTreeNode should be written.
  
--- 190,194 ----
          }
  
!     def getOutputFilenameForPackageTreeNode(self, packageTreeNode, includePath=1):
          """Returns a filename where documentation for packageTreeNode should be written.
  
***************
*** 207,210 ****
--- 207,211 ----
          trace.into('MultiFileDocSet', 'getOutputFilenameForPackageTreeNode',
                     packageTreeNode=packageTreeNode,
+                    includePath=includePath,
                     )
          
***************
*** 214,228 ****
          trace.writeVar(settings=settings)
  
!         #
!         # Get the input filename, relative to the root of the input.
!         #
!         #input_filename = packageTreeNode.getInputFilename()
!         input_filename = packageTreeNode.getRelativeFilename()
!         
!         #
!         # Add the output directory to the front of the input
!         # filename.
!         #
!         output_filename = os.path.join(self.output_directory, input_filename)
  
          if settings.get('remove_existing'):
--- 215,233 ----
          trace.writeVar(settings=settings)
  
!         if includePath:
!             #
!             # Get the input filename, relative to the root of the input.
!             #
!             input_filename = packageTreeNode.getRelativeFilename()
! 
!             #
!             # Add the output directory to the front of the input
!             # filename.
!             #
!             output_filename = os.path.join(self.output_directory, input_filename)
!             
!         else:
!             input_filename = packageTreeNode.getRelativeFilename()
!             output_filename = os.path.basename(input_filename)
  
          if settings.get('remove_existing'):
***************
*** 233,236 ****
--- 238,242 ----
          #
          normalized_output_filename = os.path.normpath(output_filename)
+             
          trace.outof(normalized_output_filename)
          return normalized_output_filename

[Happydoc-checkins] CVS: HappyDoc3/happydoclib test_scanner.py,1.4,1.5

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib
In directory sc8-pr-cvs1:/tmp/cvs-serv10284/happydoclib

Modified Files:
	test_scanner.py 
Log Message:
Tests for getPathToModule().
Tests for getDocStringAndFormat().


Index: test_scanner.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/test_scanner.py,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** test_scanner.py	1 Dec 2002 22:36:14 -0000	1.4
--- test_scanner.py	8 Dec 2002 17:01:58 -0000	1.5
***************
*** 274,278 ****
--- 274,385 ----
                               'Parents do not match.')
          return
+     
+ class ScannerRelativePathTestCase(unittest.TestCase):
+ 
+     def setUp(self):
+         import os
+         cwd = os.getcwd()
+         input_dir = os.path.join(cwd, 'TestCases/testScanner')
+         scanner = Scanner([input_dir])
+ 
+         trees = scanner.getPackageTrees()
+         expected_tree = trees[0]
+         self.expected_tree = expected_tree
+         return
+ 
+     def testSelf(self):
+         target = self.expected_tree['levelOne']['levelTwo']['two.py']
+         start = self.expected_tree['levelOne']['levelTwo']['two.py']
+ 
+         relative_path = start.getPathToNode(target)
+         self.failUnlessEqual(relative_path,
+                              (),
+                              )
+         return
+     
+     def testParentDirOfModuleDir(self):
+         target = self.expected_tree['levelOne']
+         start = self.expected_tree['levelOne']['levelTwo']['two.py']
+ 
+         relative_path = start.getPathToNode(target)
+         self.failUnlessEqual(relative_path,
+                              ('..',
+                               ),
+                              )
+         return
+     
+     def testModuleSameDir(self):
+         target = self.expected_tree['levelOne']['one.py']
+         start = self.expected_tree['levelOne']['ignoreme.py']
+ 
+         relative_path = start.getPathToNode(target)
+         self.failUnlessEqual(relative_path,
+                              ('one.py',
+                               ),
+                              )
+         return
+     
+     def testParentDirOfDir(self):
+         target = self.expected_tree['levelOne']
+         start = self.expected_tree['levelOne']['levelTwo']
+ 
+         relative_path = start.getPathToNode(target)
+         self.failUnlessEqual(relative_path,
+                              ('..',
+                               ),
+                              )
+         return
+         
+ 
+ class ScannerSummaryAndDocStringTests(unittest.TestCase):
+ 
+     def setUp(self):
+         input_dir = os.path.join('TestCases', 'testScanner')
+         output_dir = '/tmp/foo'
+         
+         scanner = Scanner([input_dir])
+ 
+         self.scanner = scanner
+         return
+ 
+     def tearDown(self):
+         del self.scanner
+         return
+     
+     def testGetReadmeTextForDirectoryInit(self):
+         trees = self.scanner.getPackageTrees()
+         expected_tree = trees[0]['readme_from_init']
+ 
+         actual, format = expected_tree.getDocStringAndFormat()
+ 
+         expected_format = 'StructuredText'
+         expected = 'This is the __init__.py file for readme_from_init.'
          
+         self.failUnlessEqual(actual, expected)
+         return
+     
+     def testGetReadmeTextForDirectoryDotTxt(self):
+         trees = self.scanner.getPackageTrees()
+         expected_tree = trees[0]['readme_from_readme']
+ 
+         actual, format = expected_tree.getDocStringAndFormat()
+ 
+         expected_format = 'StructuredText'
+         expected = 'This is the README.txt file for readme_from_readme.\n'
+         
+         self.failUnlessEqual(actual, expected)
+         return
+     
+     def testGetReadmeTextForDirectoryDotStx(self):
+         trees = self.scanner.getPackageTrees()
+         expected_tree = trees[0]['readme_from_stx']
+ 
+         actual, format = expected_tree.getDocStringAndFormat()
+ 
+         expected_format = 'StructuredText'
+         expected = 'This is the README.stx file for readme_from_stx.\n'
+         
+         self.failUnlessEqual(actual, expected)
+         return
  
  if __name__ == '__main__':

[Happydoc-checkins] CVS: HappyDoc3/happydoclib scanner.py,1.6,1.7

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib
In directory sc8-pr-cvs1:/tmp/cvs-serv10133/happydoclib

Modified Files:
	scanner.py 
Log Message:
Clean up docstrings from Python modules to remove the surrounding
quotes.
Add getPathToModule() for computing relative paths between nodes of
the tree.


Index: scanner.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/scanner.py,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** scanner.py	8 Dec 2002 16:23:24 -0000	1.6
--- scanner.py	8 Dec 2002 17:01:29 -0000	1.7
***************
*** 251,254 ****
--- 251,266 ----
          trace.outof(filename)
          return filename
+     
+     def _unquoteString(self, str):
+         "Remove surrounding quotes from a string."
+         str = str.strip()
+         while ( str
+                 and
+                 (str[0] == str[-1])
+                 and
+                 str[0] in ('"', "'")
+                 ):
+             str = str[1:-1]
+         return str
  
      def getDocStringAndFormat(self):
***************
*** 258,261 ****
--- 270,274 ----
          if hasattr(self, 'module_info'):
              docstring = self.module_info.getDocString()
+             docstring = self._unquoteString(docstring)
              format = self.module_info.getDocStringFormat()
              return (docstring, format)
***************
*** 349,352 ****
--- 362,394 ----
          trace.outof(path)
          return path
+ 
+     def getPathToNode(self, otherNode):
+         """Returns a sequence of nodes to be traversed to reach the otherNode.
+ 
+         The sequence assumes that traversal begins at the current node.
+         A '..' indicates moving up to the parent one level.
+         """
+         my_path = self.getPath()
+         other_path = otherNode.getPath()
+         if my_path == other_path:
+             return ()
+ 
+         #
+         # Strip the top parts of the paths which match.
+         #
+         while my_path and other_path and my_path[0] == other_path[0]:
+             my_path = my_path[1:]
+             other_path = other_path[1:]
+             
+         if self.items():
+             is_file = 0
+         else:
+             is_file = 1
+ 
+         going_up = ('..',) * (len(my_path) - is_file)
+ 
+         relative_path = going_up + other_path
+         
+         return relative_path
  
      def addSubNode(self, name):

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset docset_MultiHTMLFile.py,1.5,1.6

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset
In directory sc8-pr-cvs1:/tmp/cvs-serv1428/happydoclib/docset

Modified Files:
	docset_MultiHTMLFile.py 
Log Message:
Merge the list of external documentation in all formats into one list.
Skip the __init__.py file when listing modules in this directory.


Index: docset_MultiHTMLFile.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/docset_MultiHTMLFile.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** docset_MultiHTMLFile.py	8 Dec 2002 16:24:33 -0000	1.5
--- docset_MultiHTMLFile.py	8 Dec 2002 16:27:33 -0000	1.6
***************
*** 269,277 ****
          plain_text_files = contained_modules_map.get('text/plain', [])
          structured_text_files = contained_modules_map.get('text/x-structured', [])
!         text_files = plain_text_files + structured_text_files
          self._writeTOCReferencesSection(
              output,
              packageTreeNode,
!             'Text files',
              text_files,
              )
--- 269,278 ----
          plain_text_files = contained_modules_map.get('text/plain', [])
          structured_text_files = contained_modules_map.get('text/x-structured', [])
!         html_files = contained_modules_map.get('text/html', [])
!         text_files = plain_text_files + structured_text_files + html_files
          self._writeTOCReferencesSection(
              output,
              packageTreeNode,
!             'Other documentation',
              text_files,
              )
***************
*** 284,288 ****
              packageTreeNode,
              'Python files',
!             contained_modules_map.get('text/x-python', []),
              )
          
--- 285,291 ----
              packageTreeNode,
              'Python files',
!             [ cm for cm in contained_modules_map.get('text/x-python', [])
!               if cm[1].getName() != '__init__.py'
!               ],
              )
          

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset docset_MultiHTMLFile.py,1.4,1.5

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset
In directory sc8-pr-cvs1:/tmp/cvs-serv529/happydoclib/docset

Modified Files:
	docset_MultiHTMLFile.py 
Log Message:
Added method for writing a descriptive list.
Added code to write TOC.  References to contained files are listed,
but they are not hyperlinks yet.


Index: docset_MultiHTMLFile.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/docset_MultiHTMLFile.py,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** docset_MultiHTMLFile.py	7 Dec 2002 17:03:13 -0000	1.4
--- docset_MultiHTMLFile.py	8 Dec 2002 16:24:33 -0000	1.5
***************
*** 189,213 ****
          text_format = 'StructuredText'
  
-         trace.write('looking for __init__.py')
-         node = packageTreeNode.get('__init__.py')
-         if node is not None:
-             trace.write('got __init__.py')
-             readme_text = node.module_info.getDocString()
-             readme_text = self._unquoteString(readme_text)
-             text_format = node.module_info.getDocStringFormat()
- 
-         if not readme_text:
-             for name in ('README.txt', 'README.stx'):
-                 trace.write('looking for %s' % name)
-                 node = packageTreeNode.get(name)
-                 if node is not None:
-                     input_filename = node.getInputFilename()
-                     trace.write('got %s' % input_filename)
-                     readme_text = open(input_filename, 'rt').read()
-                     break
                  
          trace.outof( (readme_text, text_format))
          return (readme_text, text_format)
!     
      def writeTOCFile(self, packageTreeNode):
          trace.into('MultiHTMLFile', 'writeTOCFile',
--- 189,225 ----
          text_format = 'StructuredText'
  
                  
          trace.outof( (readme_text, text_format))
          return (readme_text, text_format)
! 
!     def _writeDescriptiveList(self, output, descriptiveList):
!         output.write('<!-- _writeDescriptiveList -->\n')
!         output.write('<table border="0" cellpadding="3" cellspacing="0">\n')
!         
!         for name, text, text_format in descriptiveList:
! 
!             output.write('''
!             <tr>
!               <td>%(name)s</td>
!               <td>''' % locals())
! 
!             self.writeText(output, text, text_format)
!             
!             output.write('''</td>
!             </tr>
!             ''')
! 
!         output.write('</table>')
!         return
! 
!     def _writeTOCReferencesSection(self, output, packageTreeNode, title, moduleList):
!         descriptive_list = [ (name,) + node.getSummaryAndFormat()
!                              for name, node in moduleList ]
!         if descriptive_list:
!             output.write('<h4>%s</h4>\n' % title)
!         descriptive_list.sort()
!         self._writeDescriptiveList(output, descriptive_list)
!         return
! 
      def writeTOCFile(self, packageTreeNode):
          trace.into('MultiHTMLFile', 'writeTOCFile',
***************
*** 219,226 ****
          output = self.openOutput(output_filename)
  
!         readme_text, text_format = self._getReadmeTextForDirectory(packageTreeNode)
! 
          self.writeText(output, readme_text, text_format)
          
          self.closeOutput(output)
  
--- 231,300 ----
          output = self.openOutput(output_filename)
  
!         #
!         # Description
!         #
!         readme_text, text_format = packageTreeNode.getDocStringAndFormat()
          self.writeText(output, readme_text, text_format)
+ 
+         #
+         # Content from __init__.py
+         #
+         try:
+             init_node = packageTreeNode['__init__.py']
+         except KeyError:
+             pass
+         else:
+             self._writePythonFileInfoToOutput(output, init_node)
+ 
+         #
+         # Group contained modules by mimetype
+         #
+         contained_modules = packageTreeNode.items()
+         contained_modules_map = {}
          
+         for name, node in contained_modules:
+             mimetype, encoding = node.getMimeType()
+             set = contained_modules_map.setdefault(mimetype, [])
+             set.append( (name, node) )
+ 
+         #output.write('Summary\n')
+         #descriptive_list = [ (name, str(len(set)), 'StructuredText') for name, set in contained_modules_map.items() ]
+         #descriptive_list.sort()
+         #self._writeDescriptiveList(output, descriptive_list)
+ 
+         #
+         # Write out references to text files we would have
+         # converted.
+         #
+         plain_text_files = contained_modules_map.get('text/plain', [])
+         structured_text_files = contained_modules_map.get('text/x-structured', [])
+         text_files = plain_text_files + structured_text_files
+         self._writeTOCReferencesSection(
+             output,
+             packageTreeNode,
+             'Text files',
+             text_files,
+             )
+         
+         #
+         # Write out references to Python files we parsed.
+         #
+         self._writeTOCReferencesSection(
+             output,
+             packageTreeNode,
+             'Python files',
+             contained_modules_map.get('text/x-python', []),
+             )
+         
+         #
+         # Write out references to subdirectories
+         #
+         self._writeTOCReferencesSection(
+             output,
+             packageTreeNode,
+             'Subdirectories',
+             contained_modules_map.get(None, []),
+             )
+ 
          self.closeOutput(output)
  
***************
*** 228,231 ****
--- 302,322 ----
          return
  
+     def _writePythonFileInfoToOutput(self, output, packageTreeNode):
+         """Writes part of the Python file information to the output stream.
+         """
+         #
+         # Imports
+         #
+ 
+         #
+         # Functions
+         #
+ 
+         #
+         # Classes
+         #
+         return
+         
+ 
      def writePythonFile(self, packageTreeNode):
          trace.into('MultiHTMLFileDocSet', 'writePythonFile',
***************
*** 252,258 ****
              ))
  
!         output_file = self.openOutput(output_filename)
!         output_file.write('\n')
!         self.closeOutput(output_file)
          
          trace.outof()
--- 343,359 ----
              ))
  
!         output = self.openOutput(output_filename)
! 
!         #
!         # Summary/module docstring
!         #
!         readme_text = packageTreeNode.module_info.getDocString()
!         readme_text = self._unquoteString(readme_text)
!         text_format = packageTreeNode.module_info.getDocStringFormat()
!         self.writeText(output, readme_text, text_format)
! 
!         self._writePythonFileInfoToOutput(output, packageTreeNode)
!         
!         self.closeOutput(output)
          
          trace.outof()

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset base.py,1.6,1.7

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset
In directory sc8-pr-cvs1:/tmp/cvs-serv348/happydoclib/docset

Modified Files:
	base.py 
Log Message:
Change default value of title and subtitle to empty string instead of
None, so we don't see None in the output.


Index: base.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/base.py,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** base.py	7 Dec 2002 17:02:48 -0000	1.6
--- base.py	8 Dec 2002 16:23:52 -0000	1.7
***************
*** 328,332 ****
          raise NotImplemented('writeTOCFile')
  
!     def writeFileHeader(self, output, title=None, subtitle=None):
          raise NotImplemented('writeFileHeader')
  
--- 328,332 ----
          raise NotImplemented('writeTOCFile')
  
!     def writeFileHeader(self, output, title='', subtitle=''):
          raise NotImplemented('writeFileHeader')
  
***************
*** 334,338 ****
          raise NotImplemented('writeFileFooter')
  
!     def openOutput(self, name, title=None, subtitle=None):
          f = open(name, 'wt')
          self.writeFileHeader(f, title=title, subtitle=subtitle)
--- 334,338 ----
          raise NotImplemented('writeFileFooter')
  
!     def openOutput(self, name, title='', subtitle=''):
          f = open(name, 'wt')
          self.writeFileHeader(f, title=title, subtitle=subtitle)

[Happydoc-checkins] CVS: HappyDoc3/happydoclib scanner.py,1.5,1.6

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib
In directory sc8-pr-cvs1:/tmp/cvs-serv32693/happydoclib

Modified Files:
	scanner.py 
Log Message:
Reorganize PackageTreeNode methods.
Add getDocStringAndFormat(), getSummaryAndFormat() methods.


Index: scanner.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/scanner.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** scanner.py	1 Dec 2002 22:35:19 -0000	1.5
--- scanner.py	8 Dec 2002 16:23:24 -0000	1.6
***************
*** 116,119 ****
--- 116,123 ----
          return '<%s %s: %s>' % (self.__class__.__name__, self.getName(), base_str)
  
+     #
+     # Parsing methods
+     #
+     
      def parsePythonInput(self):
          trace.into('PackageTree', 'parsePythonInput')
***************
*** 172,180 ****
          return
  
-     def getMimeType(self):
-         """Returns the mimetype setting for this node.
-         """
-         return self.mimetype
- 
      def parseInput(self):
          """Get whatever information is appropriate from the input file.
--- 176,179 ----
***************
*** 208,217 ****
          return
  
!     def getParent(self):
!         """Returns the parent node for this tree.
! 
!         If there is no parent (root of the tree), returns None.
          """
!         return self.parent
  
      def getName(self):
--- 207,218 ----
          return
  
!     #
!     # Data retrieval methods
!     #
!     
!     def getMimeType(self):
!         """Returns the mimetype setting for this node.
          """
!         return self.mimetype
  
      def getName(self):
***************
*** 224,227 ****
--- 225,325 ----
          """
          return self.canonical_name
+     
+     def getInputFilename(self):
+         """Returns the original input filename that created the node.
+         """
+         trace.into('PackageTree', 'getInputFilename')
+         
+         node_path = self.getPath(1)
+         trace.writeVar(node_path=node_path)
+         filename = apply(os.path.join, node_path)
+         trace.writeVar(filename=filename)
+ 
+         trace.outof(filename)
+         return filename
+ 
+     def getRelativeFilename(self):
+         """Returns the filename relative to the root of the input area.
+         """
+         trace.into('PackageTree', 'getRelativeFilename')
+         
+         node_path = self.getPath()
+         trace.writeVar(node_path=node_path)
+         filename = apply(os.path.join, node_path)
+         trace.writeVar(filename=filename)
+ 
+         trace.outof(filename)
+         return filename
+ 
+     def getDocStringAndFormat(self):
+         #
+         # Are we a python module?
+         #
+         if hasattr(self, 'module_info'):
+             docstring = self.module_info.getDocString()
+             format = self.module_info.getDocStringFormat()
+             return (docstring, format)
+ 
+         #
+         # Are we a text file?
+         #
+         if self.getName() in ('README.txt', 'README.stx'):
+             input_filename = self.getInputFilename()
+             readme_text = open(input_filename, 'rt').read()
+             format = 'StructuredText'
+             return (readme_text, format)
+ 
+         #
+         # Look inside sub-nodes
+         #
+         node = self.get('__init__.py')
+         if node is not None:
+             return node.getDocStringAndFormat()
+ 
+         for name in ('README.txt', 'README.stx'):
+             trace.write('looking for %s' % name)
+             node = self.get(name)
+             if node is not None:
+                 return node.getDocStringAndFormat()
+             
+         return ('', 'StructuredText')
+ 
+     _summary_pattern = re.compile(r'^\s*([^\n]+)\n')
+     def getSummaryAndFormat(self):
+         if hasattr(self, 'module_info'):
+             return self.module_info.getSummaryAndFormat()
+         else:
+             text, format = self.getDocStringAndFormat()
+             text = text.strip()
+             #
+             # Remove surrounding quotes, if present.
+             #
+             while text and (text[0] in ('"', "'")):
+                 text = text[1:]
+             while text and (text[-1] in ('"', "'")):
+                 text = text[:-1]
+             #
+             # Pull out the first line, and return it if
+             # we can find it.  Otherwise, return the whole
+             # string since that means that the whole thing
+             # is just one line.
+             #
+             matchObj = self._summary_pattern.search(text)
+             if matchObj:
+                 return (matchObj.group(0).strip(), format)
+             else:
+                 return (text, format)
+             
+ 
+     #
+     # Tree methods
+     #
+     
+     def getParent(self):
+         """Returns the parent node for this tree.
+ 
+         If there is no parent (root of the tree), returns None.
+         """
+         return self.parent
  
      def getPath(self, useCanonicalName=0):
***************
*** 252,282 ****
          return path
  
-     def getInputFilename(self):
-         """Returns the original input filename that created the node.
-         """
-         trace.into('PackageTree', 'getInputFilename')
-         
-         node_path = self.getPath(1)
-         trace.writeVar(node_path=node_path)
-         filename = apply(os.path.join, node_path)
-         trace.writeVar(filename=filename)
- 
-         trace.outof(filename)
-         return filename
- 
-     def getRelativeFilename(self):
-         """Returns the filename relative to the root of the input area.
-         """
-         trace.into('PackageTree', 'getRelativeFilename')
-         
-         node_path = self.getPath()
-         trace.writeVar(node_path=node_path)
-         filename = apply(os.path.join, node_path)
-         trace.writeVar(filename=filename)
- 
-         trace.outof(filename)
-         return filename
-         
- 
      def addSubNode(self, name):
          """Insert a child node under this node.
--- 350,353 ----
***************
*** 298,301 ****
--- 369,373 ----
              child.walk(callback)
          return
+ 
      
  

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/parseinfo suite.py,1.2,1.3

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/parseinfo
In directory sc8-pr-cvs1:/tmp/cvs-serv24186/happydoclib/parseinfo

Modified Files:
	suite.py 
Log Message:
Do not add comments to the end of the docstring unless there are
comments to be added.


Index: suite.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/parseinfo/suite.py,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** suite.py	1 Dec 2002 22:38:59 -0000	1.2
--- suite.py	7 Dec 2002 17:04:40 -0000	1.3
***************
*** 244,248 ****
      def getDocString(self):
          "Return any __doc__ string value found for the object."
!         dstring = '%s\n\n%s' % (self._docstring, self._comments)
          #print 'DOC STRING for %s is ' % self._name, dstring
          return dstring
--- 244,251 ----
      def getDocString(self):
          "Return any __doc__ string value found for the object."
!         if self._comments:
!             dstring = '%s\n\n%s' % (self._docstring, self._comments)
!         else:
!             dstring = self._docstring
          #print 'DOC STRING for %s is ' % self._name, dstring
          return dstring

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/parseinfo __init__.py,1.2,1.3

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/parseinfo
In directory sc8-pr-cvs1:/tmp/cvs-serv23890/happydoclib/parseinfo

Modified Files:
	__init__.py 
Log Message:
Fix tests to include expected global values.


Index: __init__.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/parseinfo/__init__.py,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** __init__.py	1 Dec 2002 22:38:38 -0000	1.2
--- __init__.py	7 Dec 2002 17:04:01 -0000	1.3
***************
*** 127,130 ****
--- 127,131 ----
  _parser_options = {
      'include_comments':1,
+     'docStringFormat':'StructuredText',
      }
  
***************
*** 351,355 ****
      def testExtractVariablesFromModule(self):
          expected_values = {
-             'include_comments':1,
              'TestInt':1,
              'TestString':"String",
--- 352,355 ----
***************
*** 357,360 ****
--- 357,361 ----
              'url': 'a=A&b=B',
              }
+         expected_values.update(_parser_options)
          module_values = self.parsed_module.getConfigurationValues()
  
***************
*** 375,380 ****
      def testExtractVariablesFromModuleWithException(self):
          expected_values = {
-             'include_comments':1,
              }
          module_values = self.parsed_module.getConfigurationValues()
          self.failUnlessEqual(module_values, expected_values)
--- 376,381 ----
      def testExtractVariablesFromModuleWithException(self):
          expected_values = {
              }
+         expected_values.update(_parser_options)
          module_values = self.parsed_module.getConfigurationValues()
          self.failUnlessEqual(module_values, expected_values)

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset test_docset_MultiHTMLFile.py,1.3,1.4

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset
In directory sc8-pr-cvs1:/tmp/cvs-serv23728/happydoclib/docset

Modified Files:
	test_docset_MultiHTMLFile.py 
Log Message:
Add tests for _getReadmeTextForDirectory.


Index: test_docset_MultiHTMLFile.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/test_docset_MultiHTMLFile.py,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** test_docset_MultiHTMLFile.py	7 Dec 2002 15:35:32 -0000	1.3
--- test_docset_MultiHTMLFile.py	7 Dec 2002 17:03:40 -0000	1.4
***************
*** 77,81 ****
      
      def runHappyDoc(self, *args):
!         default_args = ( '-d', self.getOutputDirectory(), )
          all_args = default_args + args
          happydoc = happydoclib.HappyDoc(all_args)
--- 77,81 ----
      
      def runHappyDoc(self, *args):
!         default_args = ( '-q', '-d', self.getOutputDirectory(), )
          all_args = default_args + args
          happydoc = happydoclib.HappyDoc(all_args)
***************
*** 199,202 ****
--- 199,263 ----
          self.failUnlessEqual(actual, expected)
          return
+ 
+ class MultiHTMLFileDocSetREADMETestCase(unittest.TestCase):
+ 
+     def setUp(self):
+         input_dir = os.path.join('TestCases', 'testScanner')
+         output_dir = '/tmp/foo'
+         
+         scanner = Scanner([input_dir])
+ 
+ 
+         docset = MultiHTMLFileDocSet(scanner,
+                                      'Testing',
+                                      output_dir,
+                                      )
+ 
+         self.scanner = scanner
+         self.docset = docset
+         return
+ 
+     def tearDown(self):
+         del self.scanner
+         del self.docset
+         return
+     
+     def testGetReadmeTextForDirectoryInit(self):
+         trees = self.scanner.getPackageTrees()
+         expected_tree = trees[0]['readme_from_init']
+ 
+         actual, format = self.docset._getReadmeTextForDirectory(expected_tree)
+ 
+         expected_format = 'StructuredText'
+         expected = 'This is the __init__.py file for readme_from_init.'
+         
+         self.failUnlessEqual(actual, expected)
+         return
+     
+     def testGetReadmeTextForDirectoryDotTxt(self):
+         trees = self.scanner.getPackageTrees()
+         expected_tree = trees[0]['readme_from_readme']
+ 
+         actual, format = self.docset._getReadmeTextForDirectory(expected_tree)
+ 
+         expected_format = 'StructuredText'
+         expected = 'This is the README.txt file for readme_from_readme.\n'
+         
+         self.failUnlessEqual(actual, expected)
+         return
+     
+     def testGetReadmeTextForDirectoryDotStx(self):
+         trees = self.scanner.getPackageTrees()
+         expected_tree = trees[0]['readme_from_stx']
+ 
+         actual, format = self.docset._getReadmeTextForDirectory(expected_tree)
+ 
+         expected_format = 'StructuredText'
+         expected = 'This is the README.stx file for readme_from_stx.\n'
+         
+         self.failUnlessEqual(actual, expected)
+         return
+ 
+     
  
  

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset docset_MultiHTMLFile.py,1.3,1.4

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset
In directory sc8-pr-cvs1:/tmp/cvs-serv23602/happydoclib/docset

Modified Files:
	docset_MultiHTMLFile.py 
Log Message:
Move writeTOCFile here.
Add _getReadmeTextForDirectory.


Index: docset_MultiHTMLFile.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/docset_MultiHTMLFile.py,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** docset_MultiHTMLFile.py	7 Dec 2002 15:34:59 -0000	1.3
--- docset_MultiHTMLFile.py	7 Dec 2002 17:03:13 -0000	1.4
***************
*** 170,173 ****
--- 170,231 ----
          return
  
+     def _getReadmeTextForDirectory(self, packageTreeNode):
+         """Returns the raw README text for the directory.
+ 
+         Returns first value found, in order:
+ 
+           1. __init__.py docstring
+ 
+           2. README.txt
+ 
+           3. README.stx
+           
+         """
+         trace.into('MultiHTMLFile', '_getReadmeTextForDirectory',
+                    packageTreeNode=packageTreeNode,
+                    )
+         
+         readme_text = ''
+         text_format = 'StructuredText'
+ 
+         trace.write('looking for __init__.py')
+         node = packageTreeNode.get('__init__.py')
+         if node is not None:
+             trace.write('got __init__.py')
+             readme_text = node.module_info.getDocString()
+             readme_text = self._unquoteString(readme_text)
+             text_format = node.module_info.getDocStringFormat()
+ 
+         if not readme_text:
+             for name in ('README.txt', 'README.stx'):
+                 trace.write('looking for %s' % name)
+                 node = packageTreeNode.get(name)
+                 if node is not None:
+                     input_filename = node.getInputFilename()
+                     trace.write('got %s' % input_filename)
+                     readme_text = open(input_filename, 'rt').read()
+                     break
+                 
+         trace.outof( (readme_text, text_format))
+         return (readme_text, text_format)
+     
+     def writeTOCFile(self, packageTreeNode):
+         trace.into('MultiHTMLFile', 'writeTOCFile',
+                    packageTreeNode=packageTreeNode,
+                    )
+         
+         output_filename = self.getOutputFilenameForPackageTreeNode(packageTreeNode)
+ 
+         output = self.openOutput(output_filename)
+ 
+         readme_text, text_format = self._getReadmeTextForDirectory(packageTreeNode)
+ 
+         self.writeText(output, readme_text, text_format)
+         
+         self.closeOutput(output)
+ 
+         trace.outof()
+         return
+ 
      def writePythonFile(self, packageTreeNode):
          trace.into('MultiHTMLFileDocSet', 'writePythonFile',

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset base.py,1.5,1.6

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset
In directory sc8-pr-cvs1:/tmp/cvs-serv23408/happydoclib/docset

Modified Files:
	base.py 
Log Message:
Move writeTOCFile.
Add writeText and unquoteString.


Index: base.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/base.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** base.py	7 Dec 2002 15:34:32 -0000	1.5
--- base.py	7 Dec 2002 17:02:48 -0000	1.6
***************
*** 326,341 ****
  
      def writeTOCFile(self, packageTreeNode):
!         trace.into('MultiFileDocSet', 'writeDirectory',
!                    packageTreeNode=packageTreeNode,
!                    )
!         
!         output_filename = self.getOutputFilenameForPackageTreeNode(packageTreeNode)
! 
!         file = self.openOutput(output_filename)
!         file.write('TOC goes here')
!         self.closeOutput(file)
! 
!         trace.outof()
!         return
  
      def writeFileHeader(self, output, title=None, subtitle=None):
--- 326,330 ----
  
      def writeTOCFile(self, packageTreeNode):
!         raise NotImplemented('writeTOCFile')
  
      def writeFileHeader(self, output, title=None, subtitle=None):
***************
*** 354,357 ****
--- 343,396 ----
          output.close()
          return
+     
+     def _unquoteString(self, str):
+         "Remove surrounding quotes from a string."
+         str = str.strip()
+         while ( str
+                 and
+                 (str[0] == str[-1])
+                 and
+                 str[0] in ('"', "'")
+                 ):
+             str = str[1:-1]
+         return str
+ 
+     def writeText(self, output, text, textFormat):
+         """Format and write the 'text' to the 'output'.
+ 
+         Arguments:
+ 
+           'output' -- Stream to which 'text' should be written.
+ 
+           'text' -- String to be written.
+ 
+           'textFormat' -- String identifying the format of 'text' so
+           the formatter can use a docstring converter to convert the
+           body of 'text' to the appropriate output format.
+ 
+           'quote=1' -- Boolean option to control whether the text
+           should be quoted to escape special characters.
+ 
+         """
+         if not text:
+             return
+         text = self._unquoteString(text)
+         #
+         # Get a text converter
+         #
+         converter_factory = getConverterFactory(textFormat)
+         converter = converter_factory()
+         #
+         # Do we need to quote the text?
+         #
+         #if self._html_quote_text and quote:
+         #    text = converter.quote(text, 'html')
+         #
+         # Convert and write the text.
+         #
+         html = converter.convert(text, 'html', level=3)
+         output.write(html)
+         return
+         
  
      def writePlainTextFile(self, packageTreeNode):
***************
*** 379,383 ****
  
          output_file = self.openOutput(output_filename)
-         
          output_file.write(cooked_body)
          
--- 418,421 ----

[Happydoc-checkins] CVS: HappyDoc3/happydoclib pluginloader.py,1.1.1.1,1.2

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib
In directory sc8-pr-cvs1:/tmp/cvs-serv23187/happydoclib

Modified Files:
	pluginloader.py 
Log Message:
Include the errant module name in error reporting.


Index: pluginloader.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/pluginloader.py,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -C2 -d -r1.1.1.1 -r1.2
*** pluginloader.py	17 Nov 2002 00:26:19 -0000	1.1.1.1
--- pluginloader.py	7 Dec 2002 17:02:12 -0000	1.2
***************
*** 166,170 ****
                  if int(os.environ.get('PLUGIN_DEBUG', '0')):
                      buffer = StringIO()
!                     buffer.write('\n--- Plugin Module Error ---\n')
                      traceback.print_exc(file=buffer)
                      TRACE.into('PluginLoader' 'Plugin module error',
--- 166,170 ----
                  if int(os.environ.get('PLUGIN_DEBUG', '0')):
                      buffer = StringIO()
!                     buffer.write('\n--- Plugin Module Error in %s ---\n' % _import_name)
                      traceback.print_exc(file=buffer)
                      TRACE.into('PluginLoader' 'Plugin module error',
***************
*** 179,183 ****
                      continue
                  else:
!                     sys.stderr.write('\n--- Plugin Module Error ---\n')
                      traceback.print_exc()
                      sys.stderr.write('---------------------------\n\n')
--- 179,183 ----
                      continue
                  else:
!                     sys.stderr.write('\n--- Plugin Module Error in %s ---\n' % _import_name)
                      traceback.print_exc()
                      sys.stderr.write('---------------------------\n\n')

[Happydoc-checkins] CVS: HappyDoc3/TestCases/testScanner/readme_from_stx README.stx,NONE,1.1

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/TestCases/testScanner/readme_from_stx
In directory sc8-pr-cvs1:/tmp/cvs-serv22357/TestCases/testScanner/readme_from_stx

Added Files:
	README.stx 
Log Message:
New test input files for the _getReadmeTextForDirectory() method of
the docset.


--- NEW FILE: README.stx ---
This is the README.stx file for readme_from_stx.

[Happydoc-checkins] CVS: HappyDoc3/TestCases/testScanner/readme_from_readme README.txt,NONE,1.1

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/TestCases/testScanner/readme_from_readme
In directory sc8-pr-cvs1:/tmp/cvs-serv22357/TestCases/testScanner/readme_from_readme

Added Files:
	README.txt 
Log Message:
New test input files for the _getReadmeTextForDirectory() method of
the docset.


--- NEW FILE: README.txt ---
This is the README.txt file for readme_from_readme.

[Happydoc-checkins] CVS: HappyDoc3/TestCases/testScanner/readme_from_init __init__.py,NONE,1.1

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/TestCases/testScanner/readme_from_init
In directory sc8-pr-cvs1:/tmp/cvs-serv22357/TestCases/testScanner/readme_from_init

Added Files:
	__init__.py 
Log Message:
New test input files for the _getReadmeTextForDirectory() method of
the docset.


--- NEW FILE: __init__.py ---
"This is the __init__.py file for readme_from_init."

[Happydoc-checkins] CVS: HappyDoc3/TestCases/testScanner/readme_from_stx - New directory

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/TestCases/testScanner/readme_from_stx
In directory sc8-pr-cvs1:/tmp/cvs-serv21850/TestCases/testScanner/readme_from_stx

Log Message:
Directory /cvsroot/happydoc/HappyDoc3/TestCases/testScanner/readme_from_stx added to the repository

[Happydoc-checkins] CVS: HappyDoc3/TestCases/testScanner/readme_from_readme - New directory

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/TestCases/testScanner/readme_from_readme
In directory sc8-pr-cvs1:/tmp/cvs-serv21772/TestCases/testScanner/readme_from_readme

Log Message:
Directory /cvsroot/happydoc/HappyDoc3/TestCases/testScanner/readme_from_readme added to the repository

[Happydoc-checkins] CVS: HappyDoc3/TestCases/testScanner/readme_from_init - New directory

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/TestCases/testScanner/readme_from_init
In directory sc8-pr-cvs1:/tmp/cvs-serv21709/TestCases/testScanner/readme_from_init

Log Message:
Directory /cvsroot/happydoc/HappyDoc3/TestCases/testScanner/readme_from_init added to the repository

[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset test_docset_MultiHTMLFile.py,1.2,1.3

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset
In directory sc8-pr-cvs1:/tmp/cvs-serv32730/happydoclib/docset

Modified Files:
	test_docset_MultiHTMLFile.py 
Log Message:
Updated the expected output filenames to match the actual values.


Index: test_docset_MultiHTMLFile.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docset/test_docset_MultiHTMLFile.py,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** test_docset_MultiHTMLFile.py	1 Dec 2002 22:38:06 -0000	1.2
--- test_docset_MultiHTMLFile.py	7 Dec 2002 15:35:32 -0000	1.3
***************
*** 98,103 ****
          expected_files = [ ('levelOne', 'index.html'),
                             ('levelOne', 'Existing.html'),
!                            ('levelOne', 'README.txt.html'),
!                            ('levelOne', 'one.py.html'),
                             ('levelOne', 'levelTwo'),
                             ]
--- 98,103 ----
          expected_files = [ ('levelOne', 'index.html'),
                             ('levelOne', 'Existing.html'),
!                            ('levelOne', 'README.html'),
!                            ('levelOne', 'one.html'),
                             ('levelOne', 'levelTwo'),
                             ]