summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Merry <dev@randomguy3.me.uk>2010-12-16 12:51:47 +0000
committerAlex Merry <dev@randomguy3.me.uk>2010-12-16 12:51:47 +0000
commit4170023d6326a8c5dd15c7e5688c97f5c3a14c49 (patch)
tree9453ea6f8fe909667386c74ff4da158901199a27
parent755fd5266a5f6ae956fa0b98f3950c302dcbe9ba (diff)
Make the generation of the generic-types and errors pages dependent on
there being content for them.
-rw-r--r--doc/templates/devhelp.devhelp24
-rw-r--r--doc/templates/index.html10
-rw-r--r--doc/templates/interfaces.html10
-rwxr-xr-xtools/doc-generator.py6
4 files changed, 28 insertions, 2 deletions
diff --git a/doc/templates/devhelp.devhelp2 b/doc/templates/devhelp.devhelp2
index 6cf685ac..770a93c6 100644
--- a/doc/templates/devhelp.devhelp2
+++ b/doc/templates/devhelp.devhelp2
@@ -4,8 +4,12 @@
#for $interface in $spec.interfaces
<sub name="$interface.name" link="$interface.get_url()"/>
#end for
+#if len($spec.generic_types) > 0
<sub name="Generic Types" link="generic-types.html"/>
+#end if
+#if len($spec.errors) > 0
<sub name="Errors" link="errors.html"/>
+#end if
<sub name="Full Index" link="fullindex.html"/>
</chapters>
<functions>
diff --git a/doc/templates/index.html b/doc/templates/index.html
index 7c03fe6c..0a3cde58 100644
--- a/doc/templates/index.html
+++ b/doc/templates/index.html
@@ -10,8 +10,12 @@
<h1>$spec.title</h1>
<a href="#interfaces">Interfaces</a>
(<a href="interfaces.html">Compact</a>)
+#if len($spec.generic_types) > 0
| <a href="generic-types.html">Generic Types</a>
+#end if
+#if len($spec.errors) > 0
| <a href="errors.html">Errors</a>
+#end if
| <a href="fullindex.html">Full Index</a>
</div>
@@ -66,12 +70,18 @@
$output($spec.items)
</ul>
+#if len($spec.generic_types) > 0 or len($spec.errors) > 0
<a name="other"></a>
<h3>Other</h3>
<ul>
+ #if len($spec.generic_types) > 0
<li><a href="generic-types.html">Generic Types</a></li>
+ #end if
+ #if len($spec.errors) > 0
<li><a href="errors.html">Errors</a></li>
+ #end if
</ul>
+#end if
</div>
</body>
diff --git a/doc/templates/interfaces.html b/doc/templates/interfaces.html
index a93334c6..a3ee5040 100644
--- a/doc/templates/interfaces.html
+++ b/doc/templates/interfaces.html
@@ -9,8 +9,12 @@
<div class="header">
<h1>$spec.title</h1>
<a href="index.html">Full</a>
+#if len($spec.generic_types) > 0
| <a href="generic-types.html">Generic Types</a>
+#end if
+#if len($spec.errors) > 0
| <a href="errors.html">Errors</a>
+#end if
| <a href="fullindex.html">Full Index</a>
</div>
@@ -38,12 +42,18 @@
#end for
</ul>
+#if len($spec.generic_types) > 0 or len($spec.errors) > 0
<a name="other"></a>
<h3>Other</h3>
<ul>
+ #if len($spec.generic_types) > 0
<li><a href="generic-types.html">Generic Types</a></li>
+ #end if
+ #if len($spec.errors) > 0
<li><a href="errors.html">Errors</a></li>
+ #end if
</ul>
+#end if
</div>
</body>
diff --git a/tools/doc-generator.py b/tools/doc-generator.py
index b32389a2..95a8011a 100755
--- a/tools/doc-generator.py
+++ b/tools/doc-generator.py
@@ -104,8 +104,10 @@ def render_template(name, namespaces, target=None):
namespaces = { 'spec': spec }
-render_template('generic-types.html', namespaces)
-render_template('errors.html', namespaces)
+if len(spec.generic_types) > 0:
+ render_template('generic-types.html', namespaces)
+if len(spec.errors) > 0:
+ render_template('errors.html', namespaces)
render_template('interfaces.html', namespaces)
render_template('fullindex.html', namespaces)