From e0c4fb1bc1c66e5655a41ddcbfaafb07e32b93a2 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Fri, 26 Nov 2010 20:25:02 +0000 Subject: Mark up documentation with lv2:documentation as per discussion on lv2-dev. Use unified lv2plug.in style for ontology documentation. --- gendoc.py | 45 ++++++++++++++++++++++++--------------------- 1 file changed, 24 insertions(+), 21 deletions(-) (limited to 'gendoc.py') diff --git a/gendoc.py b/gendoc.py index 603fb39..4274a09 100755 --- a/gendoc.py +++ b/gendoc.py @@ -7,7 +7,7 @@ import glob import re import datetime -out_base = os.path.join('build', 'default', 'doc') +out_base = os.path.join('build', 'default', 'ns') try: shutil.rmtree(out_base) except: @@ -17,6 +17,7 @@ os.makedirs(out_base) URIPREFIX = 'http://lv2plug.in/ns/' SPECGENDIR = './specgen' +STYLEURI = os.path.join('aux', 'style.css') release_dir = os.path.join('build', 'default', 'spec') try: @@ -39,14 +40,13 @@ def gendoc(specgen_dir, bundle_dir, ttl_filename, html_filename): subprocess.call([os.path.join(specgen_dir, 'lv2specgen.py'), os.path.join(bundle_dir, ttl_filename), os.path.join(specgen_dir, 'template.html'), - os.path.join(specgen_dir, 'style.css'), + STYLEURI, os.path.join(out_base, html_filename), - os.path.join('..', 'doc'), + os.path.join('..', '..'), '-i']) gendoc('./lv2specgen', 'core.lv2', 'lv2.ttl', 'lv2core/lv2core.html') -style = open('./lv2specgen/style.css', 'r') footer = open('./lv2specgen/footer.html', 'r') # Generate main (ontology) documentation and indices @@ -61,16 +61,13 @@ for dir in ['ext', 'extensions']: - + LV2 Extensions - -

LV2 Extensions

+ + + +

LV2 Extensions

+

""" + URIPREFIX + dir + "/

\n' + index_html += '\n
\n' - index_html += '
' + index_html += '' index_html += '\n' @@ -154,6 +151,13 @@ SELECT ?rev FROM <%s.lv2/%s.ttl> WHERE { <%s> doap:release [ doap:revision ?rev print >>index_file, index_html index_file.close() +# Copy stylesheet +try: + os.mkdir(os.path.join('build', 'default', 'aux')) +except: + pass +shutil.copy('lv2specgen/style.css', os.path.join('build', 'default', STYLEURI)) + # Generate code (headers) documentation print "** Generating header documentation" #shutil.copy('Doxyfile', os.path.join('upload', 'Doxyfile')) @@ -161,5 +165,4 @@ print ' * Calling doxygen in ' + os.getcwd() subprocess.call('doxygen', stdout=devnull) devnull.close() -style.close() footer.close() -- cgit v1.2.1