1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
#
# Time-stamp: <01/10/23 10:28:30 dhellmann>
#
# COPYRIGHT
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DISCLAIMER
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
"""Documentation set which writes output to a single file.
"""
__rcs_info__ = {
#
# Creation Information
#
'module_name':'$RCSfile: docset_SingleFile.py,v $',
'creator':'Doug Hellmann <doug@hellfly.net>',
'project':'HappyDoc',
'created':'Sat, 03-Jun-2000 18:27:00 EDT',
#
# Current Information
#
'author':'$Author: doughellmann $',
'version':'$Revision: 1.1 $',
'date':'$Date: 2001/10/24 21:27:35 $',
}
try:
__version__ = __rcs_info__['version'].split(' ')[1]
except:
__version__ = '0.0'
#
# Import system modules
#
#
# Import Local modules
#
from docset_MultipleFile import MultiFileDocSet
#
# Module
#
def entryPoint():
"Return info about this module to the dynamic loader."
return { 'name':'SingleFile',
'factory':SingleFileDocSet,
}
class SingleFileDocSet(MultiFileDocSet):
"""Documentation which writes output to a single file.
Parameters
*See MultiFileDocSet.*
"""
def _getOutputHandle(self, name, title, subtitle):
return MultiFileDocSet.openOutput( self,
name,
title,
subtitle)
def openOutput(self, name, title, subtitle=''):
"""Return a handle to the single output file."""
#
# If we already have an open handle, return it
#
if hasattr(self, '_output_handle'):
self._formatter.comment('OPEN: %s' % name, self._output_handle)
self._formatter.sectionHeader(self._output_handle, title)
self._output_handle_open_count = self._output_handle_open_count + 1
return self._output_handle
#
# This assumes that we are called first with a reasonable name
# for the single output file.
#
output_handle = self._getOutputHandle(name, title, subtitle)
#
# Store the handle for use later.
#
self._output_handle = output_handle
self._output_handle_open_count = 1
return output_handle
def closeOutput(self, output):
"""No-op"""
self._output_handle_open_count = self._output_handle_open_count - 1
self._formatter.sectionFooter(output)
return
def close(self):
self._formatter.popSectionLevel(self._output_handle)
MultiFileDocSet.closeOutput(self, self._output_handle)
return
def _writeTOC(self):
"""No-op"""
return
def _describeClassInModuleNode(self, output, class_output_file_name, class_info):
return
|
