From 401ab3ab8144e266cfc1c2d538e5ceb4a3f59102 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Thu, 20 Oct 2011 21:51:22 +0000 Subject: Cleaner and terser documentation style. --- lv2specgen/lv2specgen.py | 11 ++++--- 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 += '
  • Release (all releases)
    • \n' % (release_name, version[0], version[1]) + other_files += 'Release' % (release_name, version[0], version[1]) + other_files += ', All releases' if os.path.exists(os.path.abspath(header_path)): - other_files += '
  • Header Documentation
    • \n' % ( + other_files += ', API documentation' % ( basename + '_8h.html') header = basename + '.h' - other_files += '
  • %s
    • ' % (header, header) + other_files += ', %s' % (header, header) #other_files += '
  • Ontology %s
    • \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 += '
  • %s
    • ' % (uri, uri) + other_files += ', %s' % (uri, uri) + + other_files = 'See Also%s' % 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 @@ -

    @NAME@

    - - - - - @AUTHORS@ -
    URI@URI@
    Version@REVISION@
    Prefixes@PREFIXES@
    + + + + + + @AUTHORS@ + @FILES@ +
    URI@URI@
    Version@REVISION@
    Prefixes@PREFIXES@
    Discuss + @MAIL@ + (subscribe) +
    - -
    -

    This document is generated from @FILENAME@, - which describes @NAME@ - (an LV2 specification). Comments are - welcome, please direct discussion - to @MAIL@.

    - -

    Contents

    -
      -
    1. Description
      2. -
    2. Index
      3. -
    3. Documentation
      4. -
    4. References
      5. -
    - -

    Resources

    - +

    This document describes @NAME@. + For more information about LV2, + visit http://lv2plug.in. +

    - + - -

    1. Description

    +

    Description

    @COMMENT@
    - - -

    2. Index

    +

    Index

    @INDEX@
    - - - -

    3. Documentation

    + +

    Documentation

    @REFERENCE@
    - - -

    4. References

    -
    -
    -
    IETF RFC 2119
    -
    - - - RFC 2119: Key words for use in RFCs to Indicate Requirement Levels - . Internet Engineering Task Force, 1997. -
    -
    -
    - - -