diff options
| author | David Robillard <d@drobilla.net> | 2011-10-20 21:51:22 +0000 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2011-10-20 21:51:22 +0000 |
| commit | 401ab3ab8144e266cfc1c2d538e5ceb4a3f59102 (patch) | |
| tree | 65cbb56fcaed5f2e5549ebb2d2b45ac3720e38d3 /lv2specgen | |
| parent | 9b4d2917ce2e61ea3854670e80730dfed42c1e88 (diff) | |
| download | lv2-401ab3ab8144e266cfc1c2d538e5ceb4a3f59102.tar.xz | |
Cleaner and terser documentation style.
Diffstat (limited to 'lv2specgen')
| -rwxr-xr-x | lv2specgen/lv2specgen.py | 11 | ||||
| -rw-r--r-- | lv2specgen/template.html | 74 |
2 files changed, 27 insertions, 58 deletions
diff --git a/lv2specgen/lv2specgen.py b/lv2specgen/lv2specgen.py index 3b2ede3..5ec647a 100755 --- a/lv2specgen/lv2specgen.py +++ b/lv2specgen/lv2specgen.py @@ -908,13 +908,14 @@ def specgen(specloc, docdir, template, doclinks, instances=False, mode="spec"): release_name = "lv2-" + basename if basename == "lv2": release_name = "lv2core" - other_files += '<li><a href="http://lv2plug.in/spec/%s-%d.%d.tar.bz2">Release</a> (<a href="http://lv2plug.in/spec">all releases</a>)</li>\n' % (release_name, version[0], version[1]) + other_files += '<a href="http://lv2plug.in/spec/%s-%d.%d.tar.bz2">Release</a>' % (release_name, version[0], version[1]) + other_files += ', <a href="http://lv2plug.in/spec">All releases</a>' if os.path.exists(os.path.abspath(header_path)): - other_files += '<li><a href="' + docdir + '/html/%s">Header Documentation</a></li>\n' % ( + other_files += ', <a href="' + docdir + '/html/%s">API documentation</a>' % ( basename + '_8h.html') header = basename + '.h' - other_files += '<li><a href="%s">%s</a></li>' % (header, header) + other_files += ', <a href="%s">%s</a>' % (header, header) #other_files += '<li><a href="%s">Ontology</a> %s</li>\n' % (filename, filename) @@ -924,7 +925,9 @@ def specgen(specloc, docdir, template, doclinks, instances=False, mode="spec"): if uri[0:5] == 'file:': uri = uri[5:] - other_files += '<li><a href="%s">%s</a></li>' % (uri, uri) + other_files += ', <a href="%s">%s</a>' % (uri, uri) + + other_files = '<tr><th class="metahead">See Also</th><td>%s</td></tr>' % other_files template = template.replace('@FILES@', other_files) diff --git a/lv2specgen/template.html b/lv2specgen/template.html index d9dab0b..c3e4410 100644 --- a/lv2specgen/template.html +++ b/lv2specgen/template.html @@ -17,81 +17,47 @@ <body> <!-- HEADER --> - <div id="titleheader"> <h1 id="title">@NAME@</h1> <div class="meta"> - <table> - <tr><th class="metahead">URI</th><td><a href="@URI@">@URI@</a></td></tr> - <tr><th class="metahead">Version</th><td>@REVISION@</td></tr> - <tr><th class="metahead">Prefixes</th><td>@PREFIXES@</td></tr> - @AUTHORS@ - </table> + <table> + <tr><th class="metahead">URI</th><td><a href="@URI@">@URI@</a></td></tr> + <tr><th class="metahead">Version</th><td>@REVISION@</td></tr> + <tr><th class="metahead">Prefixes</th><td>@PREFIXES@</td></tr> + <tr><th class="metahead">Discuss</th><td> + <a href="mailto:@MAIL@">@MAIL@</a> + (<a href="http://lists.lv2plug.in/listinfo.cgi/devel-lv2plug.in">subscribe</a>) + </td></tr> + @AUTHORS@ + @FILES@ + </table> </div> </div> - <!-- META --> - <div class="content"> - <p>This document is generated from <a href="@FILENAME@">@FILENAME@</a>, - which describes <a href="@URI@">@NAME@</a> - (an <a href="http://lv2plug.in/">LV2</a> specification). Comments are - welcome, please direct discussion - to <a href="mailto:@MAIL@">@MAIL@</a>.</p> - - <h3>Contents</h3> - <ol id="toc"> - <li><a href="#sec-description">Description</a></li> - <li><a href="#sec-index">Index</a></li> - <li><a href="#sec-documentation">Documentation</a></li> - <li><a href="#sec-references">References</a></li> - </ol> - - <h3>Resources</h3> - <ul> - @FILES@ - </ul> + <p>This document describes <a href="@URI@">@NAME@</a>. + For more information about LV2, + visit <a href="http://lv2plug.in/">http://lv2plug.in</a>. + </p> </div> - + <!-- DESCRIPTION --> - - <h2 class="sec" id="sec-description">1. Description</h2> + <h2 class="sec" id="sec-description">Description</h2> <div class="content">@COMMENT@</div> - <!-- INDEX --> - - <h2 class="sec" id="sec-index">2. Index</h2> + <h2 class="sec" id="sec-index">Index</h2> <div class="content"> @INDEX@ </div> - - <!-- REFERENCE --> - - <h2 class="sec" id="sec-documentation">3. Documentation</h2> + <!-- DOCUMENTATION --> + <h2 class="sec" id="sec-documentation">Documentation</h2> <div class="content"> @REFERENCE@ </div> - <!-- REFERENCES --> - - <h2 class="sec" id="sec-references">4. References</h2> - <div class="content"> - <dl> - <dt class="label" id="ref-rfc2119">IETF RFC 2119</dt> - <dd> - <em> - <a href="http://www.ietf.org/rfc/rfc2119.txt"> - RFC 2119: Key words for use in RFCs to Indicate Requirement Levels</a> - </em>. Internet Engineering Task Force, 1997. - </dd> - </dl> - </div> - - <!-- FOOTER --> - <div id="footer"> <span class="footer-text">Generated on @TIME@ from <a href="./@FILENAME@" class="footer-text">@FILENAME@</a> by <a href="http://drobilla.net/software/lv2specgen" class="footer-text">lv2specgen</a></span> @FOOTER@ |