viff

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 diff
     1.1 --- a/doc/conf.py	Sun Jul 27 17:43:42 2008 +0200
     1.2 +++ b/doc/conf.py	Sun Jul 27 17:55:13 2008 +0200
     1.3 @@ -31,7 +31,7 @@
     1.4  # Add any Sphinx extension module names here, as strings. They can be
     1.5  # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
     1.6  # ones.
     1.7 -extensions = ['sphinx.ext.autodoc']
     1.8 +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.ifconfig']
     1.9  
    1.10  # Add any paths that contain templates here, relative to this directory.
    1.11  templates_path = []
    1.12 @@ -54,7 +54,7 @@
    1.13  # The short X.Y version.
    1.14  version = viff.__version__
    1.15  # The full version, including alpha/beta/rc tags.
    1.16 -release = viff.__version__
    1.17 +release = viff.release()
    1.18  
    1.19  # There are two options for replacing |today|: either, you set today
    1.20  # to some non-false value, then it is used:
     2.1 --- a/doc/index.txt	Sun Jul 27 17:43:42 2008 +0200
     2.2 +++ b/doc/index.txt	Sun Jul 27 17:55:13 2008 +0200
     2.3 @@ -5,13 +5,23 @@
     2.4  The Virtual Ideal Functionality Framework is a general framework for
     2.5  doing secure multi-party computation.
     2.6  
     2.7 -This is the documentation for VIFF |version|. Documentation for other
     2.8 -versions can be found online_. If you have comments and suggestions
     2.9 -for improvements to the documentation, then please `let us know`_.
    2.10 +This is the documentation for VIFF |version|. If you have comments and
    2.11 +suggestions for improvements to the documentation, then please `let us
    2.12 +know`_.
    2.13  
    2.14 -.. _online:  http://viff.dk/doc/
    2.15  .. _let us know: viff-devel@viff.dk
    2.16  
    2.17 +.. ifconfig:: version != release
    2.18 +
    2.19 +   .. warning::
    2.20 +
    2.21 +      This documentation is for a development version of VIFF (version
    2.22 +      |release|) built |today| and it might be different from the last
    2.23 +      released version. The documentation for other releases can be
    2.24 +      found online_.
    2.25 +
    2.26 +      .. _online:  http://viff.dk/doc/
    2.27 +
    2.28  
    2.29  Contents:
    2.30