|
From: Doug H. <dou...@us...> - 2002-05-13 01:14:48
|
Update of /cvsroot/happydoc/HappyDoc/happydoclib/docset
In directory usw-pr-cvs1:/tmp/cvs-serv10733/happydoclib/docset
Modified Files:
Tag: dos_path_bug
docset_MultipleFile.py
Log Message:
Initial pass at a fix for the Win32 path problems, including simplifying the definition of the path to the output file for an objects documentation.
Index: docset_MultipleFile.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc/happydoclib/docset/docset_MultipleFile.py,v
retrieving revision 1.5
retrieving revision 1.5.2.1
diff -C2 -d -r1.5 -r1.5.2.1
*** docset_MultipleFile.py 9 Dec 2001 15:36:33 -0000 1.5
--- docset_MultipleFile.py 13 May 2002 01:14:44 -0000 1.5.2.1
***************
*** 103,106 ****
--- 103,107 ----
def write(self):
"Write the documentation set to the output."
+ happydoclib.TRACE.into('MultiFileDocSet', 'write')
self.statusMessage('Beginning to write...')
#
***************
*** 108,112 ****
--- 109,115 ----
#
self._root_name = self._formatter.getFullOutputNameForObject(None)
+ happydoclib.TRACE.writeVar(root_name=self._root_name)
self._root_node = self.openOutput( self._root_name, self._title, '' )
+ happydoclib.TRACE.writeVar(root_node=self._root_node)
#
# Get the description for the docset from the
***************
*** 126,129 ****
--- 129,133 ----
#
self.close()
+ happydoclib.TRACE.outof()
return
***************
*** 158,173 ****
#
for x in items:
! happydoclib.TRACE.into('', 'loop', x=x)
node_name = x[0]
happydoclib.TRACE.writeVar(node_name=node_name)
dir_name = happydoclib.path.dirname(x[1].getFilename())
happydoclib.TRACE.writeVar(dir_name=dir_name)
if removePrefix:
happydoclib.TRACE.write('removing prefix')
dir_name = happydoclib.path.removeRelativePrefix( dir_name )
file_name = x[1].getFilename()
happydoclib.TRACE.writeVar(file_name=file_name)
rec = (dir_name, file_name, node_name)
subnode_ids.append(rec)
happydoclib.TRACE.outof(rec)
#
--- 162,184 ----
#
for x in items:
! happydoclib.TRACE.into('inputDict.items()', 'loop', x=x)
!
node_name = x[0]
happydoclib.TRACE.writeVar(node_name=node_name)
+
dir_name = happydoclib.path.dirname(x[1].getFilename())
happydoclib.TRACE.writeVar(dir_name=dir_name)
+
if removePrefix:
happydoclib.TRACE.write('removing prefix')
dir_name = happydoclib.path.removeRelativePrefix( dir_name )
+ happydoclib.TRACE.writeVar(dir_name=dir_name)
+
file_name = x[1].getFilename()
happydoclib.TRACE.writeVar(file_name=file_name)
+
rec = (dir_name, file_name, node_name)
subnode_ids.append(rec)
+
happydoclib.TRACE.outof(rec)
#
***************
*** 176,189 ****
#
for dir_name, file_name, subnode_name in subnode_ids:
! happydoclib.TRACE.writeVar(dir_name=dir_name)
! happydoclib.TRACE.writeVar(file_name=file_name)
! happydoclib.TRACE.writeVar(subnode_name=subnode_name)
! #print 'DIR : %s' % dir_name
! #print 'FILE : %s' % file_name
! #print 'NODE : %s' % subnode_name
! #print
l = outputDict.get(dir_name, [])
l.append( (file_name, subnode_name, inputDict) )
outputDict[dir_name] = l
happydoclib.TRACE.outof()
return
--- 187,199 ----
#
for dir_name, file_name, subnode_name in subnode_ids:
! happydoclib.TRACE.into('subnode_ids', 'loop',
! dir_name=dir_name,
! file_name=file_name,
! subnode_name=subnode_name)
l = outputDict.get(dir_name, [])
l.append( (file_name, subnode_name, inputDict) )
outputDict[dir_name] = l
+ happydoclib.TRACE.outof()
+
happydoclib.TRACE.outof()
return
***************
*** 192,195 ****
--- 202,206 ----
"Output the TOC."
happydoclib.TRACE.into('MultiFileDocSet', '_writeTOC')
+ happydoclib.TRACE.writeVar(docset_name=self.getName())
self.statusMessage()
self.statusMessage('Writing table of contents...')
***************
*** 207,210 ****
--- 218,222 ----
self._organizeSubNodesByDir(subnodes_by_dir, self._all_modules, removePrefix=1)
self._organizeSubNodesByDir(subnodes_by_dir, self._all_packages, removePrefix=0)
+ happydoclib.TRACE.writeVar(subnodes_by_dir=subnodes_by_dir)
#
***************
*** 219,223 ****
for dir_name in dirs:
! happydoclib.TRACE.into('', '', directory=dir_name)
relative_dir_name = happydoclib.path.removeRelativePrefix(dir_name)
#
--- 231,235 ----
for dir_name in dirs:
! happydoclib.TRACE.into('dirs', 'loop', directory=dir_name)
relative_dir_name = happydoclib.path.removeRelativePrefix(dir_name)
#
***************
*** 265,270 ****
--- 277,289 ----
subnode_set.sort(lambda x, y: cmp(x[1], y[1]))
for file_name, subnode_name, subnode_dict in subnode_set:
+ happydoclib.TRACE.into('subnode_set', 'loop',
+ file_name=file_name,
+ subnode_name=subnode_name,
+ subnode_dict=subnode_dict,
+ )
+
subnode = subnode_dict[subnode_name]
self.statusMessage('\tAdding %s to TOC' % subnode_name, 2)
+
#
# Build a reference to the documentation for the subnode
***************
*** 272,277 ****
--- 291,298 ----
#
new_ref = subnode.getReference(formatter, self._root_node)
+
happydoclib.TRACE.writeVar(root_node_name=self._root_node.name)
happydoclib.TRACE.writeVar(new_ref=new_ref)
+
if hasattr( subnode, 'getFullOutputNameForObject' ):
happydoclib.TRACE.write('using getFullOutputNameForObject')
***************
*** 285,288 ****
--- 306,310 ----
self._root_name,
)
+
happydoclib.TRACE.writeVar(ref=ref)
subnode_summary, subnode_format = subnode.getSummaryAndFormat()
***************
*** 293,298 ****
--- 315,324 ----
subnode_format,
)
+
+ happydoclib.TRACE.outof()
+
formatter.descriptiveListFooter(self._root_node)
happydoclib.TRACE.outof()
+
#
# Close the Modules section
***************
*** 385,389 ****
def _describeClassInModuleNode(self, output, class_output_file_name, class_info):
! ref = self._formatter.getReference(class_info, class_output_file_name)
class_info_summary, class_info_format = class_info.getSummaryAndFormat()
self._formatter.descriptiveListItem( output,
--- 411,421 ----
def _describeClassInModuleNode(self, output, class_output_file_name, class_info):
! happydoclib.TRACE.into('', '_describeClassInModuleNode',
! output=output,
! class_output_file_name=class_output_file_name,
! class_info=class_info,
! )
! #ref = self._formatter.getReference(class_info, class_output_file_name)
! ref = self._formatter.getReference(class_info, output.name)
class_info_summary, class_info_format = class_info.getSummaryAndFormat()
self._formatter.descriptiveListItem( output,
***************
*** 392,395 ****
--- 424,428 ----
class_info_format,
)
+ happydoclib.TRACE.outof()
return
***************
*** 535,540 ****
--- 568,575 ----
class_names.sort()
for class_name in class_names:
+ happydoclib.TRACE.into('class_names', 'loop', class_name=class_name)
c = module.getClassInfo(class_name)
class_output_name = formatter.getFullOutputNameForObject(c)
+ happydoclib.TRACE.writeVar(class_output_name=class_output_name)
self._describeClassInModuleNode(output, class_output_name , c)
class_output = self.openOutput(class_output_name,
***************
*** 543,546 ****
--- 578,582 ----
self._writeClass( module, class_name, class_output )
self.closeOutput(class_output)
+ happydoclib.TRACE.outof()
formatter.descriptiveListFooter(output)
formatter.sectionFooter( output )
***************
*** 587,590 ****
--- 623,631 ----
def _writeClass(self, parent, class_name, output):
"Output the documentation for the class in the parent object."
+ happydoclib.TRACE.into('MultiFileDocSet', '_writeClass',
+ parent=parent,
+ class_name=class_name,
+ output=output,
+ )
class_info = parent.getClassInfo(class_name)
formatter = self._formatter
***************
*** 598,601 ****
--- 639,643 ----
#
base_classes = self._filterNames(class_info.getBaseClassNames())
+ happydoclib.TRACE.writeVar(base_classes=base_classes)
if base_classes:
formatter.pushSectionLevel(output)
***************
*** 632,635 ****
--- 674,678 ----
output)
formatter.sectionFooter(output)
+
#
# Finish that indented level.
***************
*** 638,641 ****
--- 681,686 ----
formatter.popSectionLevel(output)
formatter.comment('END: Class %s' % class_name, output)
+
+ happydoclib.TRACE.outof()
return
|
