changeset 850:6d8e69b5ec1a

Warn people if documentation is for a development version.
author Martin Geisler <mg@daimi.au.dk>
date Sun, 27 Jul 2008 17:55:13 +0200
parents b42cf723fa4c
children 660d22033155
files doc/conf.py doc/index.txt
diffstat 2 files changed, 16 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/doc/conf.py	Sun Jul 27 17:43:42 2008 +0200
+++ b/doc/conf.py	Sun Jul 27 17:55:13 2008 +0200
@@ -31,7 +31,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.ifconfig']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = []
@@ -54,7 +54,7 @@
 # The short X.Y version.
 version = viff.__version__
 # The full version, including alpha/beta/rc tags.
-release = viff.__version__
+release = viff.release()
 
 # There are two options for replacing |today|: either, you set today
 # to some non-false value, then it is used:
--- a/doc/index.txt	Sun Jul 27 17:43:42 2008 +0200
+++ b/doc/index.txt	Sun Jul 27 17:55:13 2008 +0200
@@ -5,13 +5,23 @@
 The Virtual Ideal Functionality Framework is a general framework for
 doing secure multi-party computation.
 
-This is the documentation for VIFF |version|. Documentation for other
-versions can be found online_. If you have comments and suggestions
-for improvements to the documentation, then please `let us know`_.
+This is the documentation for VIFF |version|. If you have comments and
+suggestions for improvements to the documentation, then please `let us
+know`_.
 
-.. _online:  http://viff.dk/doc/
 .. _let us know: viff-devel@viff.dk
 
+.. ifconfig:: version != release
+
+   .. warning::
+
+      This documentation is for a development version of VIFF (version
+      |release|) built |today| and it might be different from the last
+      released version. The documentation for other releases can be
+      found online_.
+
+      .. _online:  http://viff.dk/doc/
+
 
 Contents: