[Epydoc-commits] SF.net SVN: epydoc: [1410] tags/exp-compact-html/epydoc/src/epydoc/ docwriter
Brought to you by:
edloper
Menu
▾
▴
[Epydoc-commits] SF.net SVN: epydoc: [1410] tags/exp-compact-html/epydoc/src/epydoc/ docwriter
|
From: <dva...@us...> - 2006-10-13 00:35:40
|
Revision: 1410
http://svn.sourceforge.net/epydoc/?rev=1410&view=rev
Author: dvarrazzo
Date: 2006-10-12 17:35:28 -0700 (Thu, 12 Oct 2006)
Log Message:
-----------
- html and css allow more compact output.
- dropped many empty definition lists, using css margins instead.
Modified Paths:
--------------
tags/exp-compact-html/epydoc/src/epydoc/docwriter/html.py
tags/exp-compact-html/epydoc/src/epydoc/docwriter/html_css.py
Modified: tags/exp-compact-html/epydoc/src/epydoc/docwriter/html.py
===================================================================
--- tags/exp-compact-html/epydoc/src/epydoc/docwriter/html.py 2006-10-13 00:33:22 UTC (rev 1409)
+++ tags/exp-compact-html/epydoc/src/epydoc/docwriter/html.py 2006-10-13 00:35:28 UTC (rev 1410)
@@ -1815,7 +1815,6 @@
# Write a footer for the table.
out(self.TABLE_FOOTER)
- out('\n<br />\n')
def write_summary_group(self, out, doc, name, var_docs, grouped_inh_vars):
# Split up the var_docs list, according to the way each var
@@ -1964,18 +1963,15 @@
if not var_docs: return
# Write a header
- self.write_table_header(out, "summary", heading)
- out(self.TABLE_FOOTER)
+ self.write_table_header(out, "details", heading)
for var_doc in var_docs:
self.write_details_entry(out, var_doc)
- out('<br />\n')
+ out(self.TABLE_FOOTER)
def write_details_entry(self, out, var_doc):
- descr = self.descr(var_doc, indent=2)
- if descr: descr = '<br />'+descr
- else: descr = ''
+ descr = self.descr(var_doc, indent=2) or ''
if var_doc.is_public: div_class = ''
else: div_class = ' class="private"'
@@ -2039,8 +2035,8 @@
return self.function_signature(val_doc, True, True)
elif isinstance(val_doc, GenericValueDoc):
return ('<table><tr><td><pre class="variable">\n' +
- self.pprint_value(val_doc) +
- '\n</pre></td></tr></table>\n')
+ self.pprint_value(val_doc).rstrip() +
+ '</pre></td></tr></table>\n')
else:
return self.href(val_doc)
else:
@@ -2069,21 +2065,19 @@
# /------------------------- Template -------------------------\
'''
>>> func_doc = var_doc.value
- <a name="$var_doc.name$"></a>
- <div$div_class$>
- >>> self.write_table_header(out, "details")
- <tr><td>
+ <tr$div_class$><td class="details">
+ <a name="$var_doc.name$"></a>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc">$self.function_signature(var_doc)$
>>> if var_doc.name in self.SPECIAL_METHODS:
- <br /><em class="fname">($self.SPECIAL_METHODS[var_doc.name]$)</em>
+ <em class="fname">($self.SPECIAL_METHODS[var_doc.name]$)</em>
>>> #endif
>>> if isinstance(func_doc, ClassMethodDoc):
- <br /><em class="fname">Class Method</em>
+ <em class="fname"> - Class Method</em>
>>> #endif
>>> if isinstance(func_doc, StaticMethodDoc):
- <br /><em class="fname">Static Method</em>
+ <em class="fname"> - Static Method</em>
>>> #endif
</h3>
</td><td align="right" valign="top"
@@ -2092,10 +2086,10 @@
</table>
$self.render_callgraph(callgraph)$
$descr$
- <dl><dt></dt><dd>
+ <div class="fields">
>>> # === parameters ===
>>> if arg_descrs:
- <dl><dt>Parameters:</dt></dl>
+ <p><strong class="field_name">Parameters:</strong></p>
<ul class="nomargin">
>>> for lhs, rhs in arg_descrs:
$self.labelled_list_item(lhs, rhs)$
@@ -2104,13 +2098,14 @@
>>> #endif
>>> # === return type ===
>>> if rdescr and rtype:
- <dl><dt>Returns: $rtype$</dt>
- <dd>$rdescr$</dd></dl>
+ <p><strong class="field_name">Returns:</strong>
+ ($rtype$) $rdescr$</p>
>>> elif rdescr:
- <dl><dt>Returns:</dt>
- <dd>$rdescr$</dd></dl>
+ <p><strong class="field_name">Returns:</strong>
+ $rdescr$</p>
>>> elif rtype:
- <dl><dt>Returns: $rtype$</dt></dl>
+ <p><strong class="field_name">Returns:</strong>
+ $rtype$</p>
>>> #endif
>>> # === decorators ===
>>> if func_doc.decorators not in (None, UNKNOWN):
@@ -2125,7 +2120,7 @@
>>> decos = None
>>> #endif
>>> if decos:
- <dl><dt>Decorators:</dt></dl>
+ <p><strong class="field_name">Decorators:</strong></p>
<ul class="nomargin">
>>> for deco in decos:
<li><code>@$deco$</code></li>
@@ -2134,7 +2129,7 @@
>>> #endif
>>> # === exceptions ===
>>> if func_doc.exception_descrs not in (None, UNKNOWN, (), []):
- <dl><dt>Raises:</dt></dl>
+ <p><strong class="field_name">Raises:</strong></p>
<ul class="nomargin">
>>> for name, descr in func_doc.exception_descrs:
>>> exc_name = self.docindex.find(name, func_doc)
@@ -2150,19 +2145,18 @@
>>> #endif
>>> # === overrides ===
>>> if var_doc.overrides not in (None, UNKNOWN):
- <dl><dt>Overrides:
+ <p><strong class="field_name">Overrides:
$self.href(var_doc.overrides.value, context=var_doc)$
>>> if (func_doc.docstring in (None, UNKNOWN) and
>>> var_doc.overrides.value.docstring not in (None, UNKNOWN)):
- <dd><em class="note">(inherited documentation)</em></dd>
+ <em class="note">(inherited documentation)</em>
>>> #endif
- </dt></dl>
+ </strong></p>
>>> #endif
>>> # === metadata ===
>>> self.write_standard_fields(out, func_doc)
- </dd></dl>
- </td></tr></table>
- </div>
+ </div>
+ </td></tr>
''')
# \------------------------------------------------------------/
@@ -2206,29 +2200,26 @@
# /------------------------- Template -------------------------\
'''
>>> prop_doc = var_doc.value
- <a name="$var_doc.name$"></a>
- <div$div_class$>
- >>> self.write_table_header(out, "details")
- <tr><td>
+ <tr$div_class$><td class="details">
+ <a name="$var_doc.name$"></a>
<h3 class="epydoc">$var_doc.name$</h3>
$descr$
- <dl><dt></dt><dd>
+ <div class="fields">
+ >>> if prop_doc.type_descr not in (None, UNKNOWN):
+ <p><strong class="field_name">Type:</strong>
+ $self.type_descr(var_doc, indent=6)$</p>
+ >>> #endif
>>> for (name, val, summary) in accessors:
- <dl><dt>$name$ Method:</dt>
- <dd>$val$
+ <p><strong class="field_name">$name$ Method:</strong>
+ $val$
>>> if summary:
- $summary$
>>> #endif
- </dd></dl>
+ </p>
>>> #endfor
- >>> if prop_doc.type_descr not in (None, UNKNOWN):
- <dl><dt>Type:</dt>
- <dd>$self.type_descr(var_doc, indent=6)$</dd></dl>
- >>> #endif
>>> self.write_standard_fields(out, prop_doc)
- </dd></dl>
- </td></tr></table>
- </div>
+ </div>
+ </td></tr>
''')
# \------------------------------------------------------------/
@@ -2238,28 +2229,23 @@
''',
# /------------------------- Template -------------------------\
'''
- <a name="$var_doc.name$"></a>
- <div$div_class$>
- >>> self.write_table_header(out, "details")
- <tr><td>
+ <tr$div_class$><td class="details">
+ <a name="$var_doc.name$"></a>
<h3 class="epydoc">$var_doc.name$</h3>
$descr$
- <dl><dt></dt><dd>
+ <div class="fields">
>>> if var_doc.type_descr not in (None, UNKNOWN):
- <dl><dt>Type:</dt>
- <dd>$self.type_descr(var_doc, indent=6)$</dd></dl>
+ <p><strong class="field_name">Type:</strong>
+ $self.type_descr(var_doc, indent=6)$</p>
>>> #endif
>>> self.write_standard_fields(out, var_doc)
>>> if var_doc.value is not UNKNOWN:
- <dl><dt>Value:</dt>
- <dd><table><tr><td><pre class="variable">
- $self.pprint_value(var_doc.value)$
- </pre></td></tr></table></dd>
- </dl>
+ <p><strong class="field_name">Value:</strong>
+ <code class="variable">$self.pprint_value(var_doc.value).rstrip()$</code>
+ </p>
>>> #endif
- </dd></dl>
- </td></tr></table>
- </div>
+ </div>
+ </td></tr>
''')
# \------------------------------------------------------------/
@@ -2862,8 +2848,7 @@
<!-- ==================== $heading.upper()$ ==================== -->
<a name="$anchor$"></a>
>>> #endif
- <table class="$css_class$" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
+ <table class="$css_class$">
>>> if heading is not None:
<tr bgcolor="#70b0f0" class="table-header">
>>> if private_link:
Modified: tags/exp-compact-html/epydoc/src/epydoc/docwriter/html_css.py
===================================================================
--- tags/exp-compact-html/epydoc/src/epydoc/docwriter/html_css.py 2006-10-13 00:33:22 UTC (rev 1409)
+++ tags/exp-compact-html/epydoc/src/epydoc/docwriter/html_css.py 2006-10-13 00:35:28 UTC (rev 1410)
@@ -85,7 +85,7 @@
h2.epydoc { font-size: +130%; font-weight: bold; }
h3.epydoc { font-size: +115%; font-weight: bold; }
td h3.epydoc { font-size: +115%; font-weight: bold;
- margin-bottom: 0; }
+ margin: 0; }
table.navbar { background: #a0c0ff; color: #000000;
border: 2px groove #c0d0d0; }
table.navbar table { color: #000000; }
@@ -128,8 +128,11 @@
*/
table.summary { border-collapse: collapse;
background: #e8f0f8; color: #000000;
- border: 1px solid #608090; }
-td.summary { border: 1px solid #608090; }
+ border: 1px solid #608090;
+ margin: 0.25em 0 0.25em 0;
+ width: 100%; }
+td.summary { border: 1px solid #608090;
+ padding: 0.1em 0.3em 0.1em 0.3em; }
code.summary-type { font-size: 85%; }
table.summary a:link { color: #0000ff; }
table.summary a:visited { color: #204080; }
@@ -144,10 +147,14 @@
table.details { border-collapse: collapse;
background: #e8f0f8; color: #000000;
border: 1px solid #608090;
- margin: .2em 0 0 0; }
-table.details table { color: #000000; }
+ margin: 0.25em 0 0.25em 0;
+ width: 100%; }
table.details a:link { color: #0000ff; }
table.details a:visited { color: #204080; }
+table.details p { margin: 0.2em ; }
+table.details div.fields { margin-left: 2em; }
+table.details td.details { border: 1px solid #608090;
+ padding: 0.2em 0.3em 0.2em 0.3em; }
/* Index tables (identifier index, term index, etc)
* - link-index is used for indices containing lists of links
@@ -167,7 +174,8 @@
table.metadata-index { border-collapse: collapse;
background: #e8f0f8; color: #000000;
border: 1px solid #608090;
- margin: .2em 0 0 0; }
+ margin: .2em 0 0 0;
+ width: 100%; }
td.metadata-index { border-width: 1px; border-style: solid; }
table.metadata-index a:link { color: #0000ff; }
table.metadata-index a:visited { color: #204080; }
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
