From 3ec294f44bb3daac4814b2e63ad3234fe5cefcf6 Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Wed, 26 Nov 2014 16:21:49 -0500
Subject: Add link to spec index on spec pages.
---
lv2specgen/lv2specgen.py | 8 ++++++--
wscript | 10 +++++++++-
2 files changed, 15 insertions(+), 3 deletions(-)
diff --git a/lv2specgen/lv2specgen.py b/lv2specgen/lv2specgen.py
index 00310d6..0aea05b 100755
--- a/lv2specgen/lv2specgen.py
+++ b/lv2specgen/lv2specgen.py
@@ -1113,7 +1113,7 @@ def load_tags(path, docdir):
return linkmap
-def specgen(specloc, indir, style_uri, docdir, tags, opts, instances=False):
+def specgen(specloc, indir, style_uri, docdir, tags, opts, instances=False, root_link=None):
"""The meat and potatoes: Everything starts here."""
global spec_url
@@ -1221,7 +1221,11 @@ def specgen(specloc, indir, style_uri, docdir, tags, opts, instances=False):
if instances:
termlist += docTerms('Instance', instalist, m, classlist, proplist, instalist)
- template = template.replace('@NAME@', specProperty(m, spec, doap.name))
+ name = specProperty(m, spec, doap.name)
+ if root_link:
+ name = '<a href="%s">%s</a>' % (root_link, name)
+
+ template = template.replace('@NAME@', name)
template = template.replace('@SHORT_DESC@', specProperty(m, spec, doap.shortdesc))
template = template.replace('@URI@', spec)
template = template.replace('@PREFIX@', spec_pre)
diff --git a/wscript b/wscript
index e3fa60a..3951e64 100644
--- a/wscript
+++ b/wscript
@@ -165,6 +165,13 @@ def specgen(task):
if name.startswith('LV2 '):
name = name[4:]
+ # Root link
+ ctx = task.generator.bld
+ root_path = path[0:path.find('ns/') + 3]
+ root_link = os.path.relpath(root_path, path)
+ if not task.generator.bld.env.ONLINE_DOCS:
+ root_link = os.path.join(root_link, 'index.html')
+
SPECGENDIR = 'lv2specgen'
STYLEPATH = 'build/aux/style.css'
TAGFILE = 'build/doc/tags'
@@ -177,7 +184,8 @@ def specgen(task):
TAGFILE,
{ 'list_email': 'devel@lists.lv2plug.in',
'list_page': 'http://lists.lv2plug.in/listinfo.cgi/devel-lv2plug.in' },
- instances=True)
+ instances=True,
+ root_link=root_link)
lv2specgen.save(task.outputs[0].abspath(), specdoc)
--
cgit v1.2.1