viff

changeset 697:c08da3f0859d

Added Sphinx skeleton.
author Martin Geisler <mg@daimi.au.dk>
date Tue, 22 Apr 2008 08:21:11 +0200
parents d344c748fa5e
children 50bf10e379e0
files doc/conf.py doc/glossary.txt doc/index.txt
diffstat 3 files changed, 180 insertions(+), 0 deletions(-) [+]
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/conf.py	Tue Apr 22 08:21:11 2008 +0200
     1.3 @@ -0,0 +1,144 @@
     1.4 +# -*- coding: utf-8 -*-
     1.5 +#
     1.6 +# VIFF documentation build configuration file, created by
     1.7 +# sphinx-quickstart on Mon Apr 21 08:54:10 2008.
     1.8 +#
     1.9 +# This file is execfile()d with the current directory set to its
    1.10 +# containing dir.
    1.11 +#
    1.12 +# The contents of this file are pickled, so don't put values in the
    1.13 +# namespace that aren't pickleable (module imports are okay, they're
    1.14 +# removed automatically).
    1.15 +#
    1.16 +# All configuration values have a default value; values that are
    1.17 +# commented out serve to show the default value.
    1.18 +
    1.19 +import sys
    1.20 +
    1.21 +# If your extensions are in another directory, add it here.
    1.22 +#sys.path.append('some/directory')
    1.23 +
    1.24 +# Ensure we load VIFF from the parent directory.
    1.25 +import os.path
    1.26 +sys.path.insert(0, os.path.abspath('../'))
    1.27 +
    1.28 +# General configuration
    1.29 +# ---------------------
    1.30 +
    1.31 +# Add any Sphinx extension module names here, as strings. They can be
    1.32 +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
    1.33 +# ones.
    1.34 +extensions = ['sphinx.ext.autodoc']
    1.35 +
    1.36 +# Add any paths that contain templates here, relative to this directory.
    1.37 +templates_path = ['templates']
    1.38 +
    1.39 +# The suffix of source filenames.
    1.40 +source_suffix = '.txt'
    1.41 +
    1.42 +# The master toctree document.
    1.43 +master_doc = 'index'
    1.44 +
    1.45 +# General substitutions.
    1.46 +project = 'VIFF'
    1.47 +copyright = '2008, VIFF Development Team'
    1.48 +
    1.49 +import viff
    1.50 +
    1.51 +# The default replacements for |version| and |release|, also used in
    1.52 +# various other places throughout the built documents.
    1.53 +#
    1.54 +# The short X.Y version.
    1.55 +version = viff.__version__
    1.56 +# The full version, including alpha/beta/rc tags.
    1.57 +release = viff.__version__
    1.58 +
    1.59 +# There are two options for replacing |today|: either, you set today
    1.60 +# to some non-false value, then it is used:
    1.61 +#today = ''
    1.62 +# Else, today_fmt is used as the format for a strftime call.
    1.63 +today_fmt = '%B %d, %Y'
    1.64 +
    1.65 +# List of documents that shouldn't be included in the build.
    1.66 +#unused_docs = []
    1.67 +
    1.68 +# If true, '()' will be appended to :func: etc. cross-reference text.
    1.69 +#add_function_parentheses = True
    1.70 +
    1.71 +# If true, the current module name will be prepended to all
    1.72 +# description unit titles (such as .. function::).
    1.73 +#add_module_names = True
    1.74 +
    1.75 +# If true, sectionauthor and moduleauthor directives will be shown in
    1.76 +# the output. They are ignored by default.
    1.77 +#show_authors = False
    1.78 +
    1.79 +# The name of the Pygments (syntax highlighting) style to use.
    1.80 +pygments_style = 'sphinx'
    1.81 +
    1.82 +
    1.83 +# Options for HTML output
    1.84 +# -----------------------
    1.85 +
    1.86 +# The style sheet to use for HTML and HTML Help pages. A file of that
    1.87 +# name must exist either in Sphinx' static/ path, or in one of the
    1.88 +# custom paths given in html_static_path.
    1.89 +html_style = 'default.css'
    1.90 +
    1.91 +# Add any paths that contain custom static files (such as style
    1.92 +# sheets) here, relative to this directory. They are copied after the
    1.93 +# builtin static files, so a file named "default.css" will overwrite
    1.94 +# the builtin "default.css".
    1.95 +html_static_path = ['static']
    1.96 +
    1.97 +# If not '', a 'Last updated on:' timestamp is inserted at every page
    1.98 +# bottom, using the given strftime format.
    1.99 +html_last_updated_fmt = '%b %d, %Y'
   1.100 +
   1.101 +# If true, SmartyPants will be used to convert quotes and dashes to
   1.102 +# typographically correct entities.
   1.103 +#html_use_smartypants = True
   1.104 +
   1.105 +# Content template for the index page.
   1.106 +#html_index = ''
   1.107 +
   1.108 +# Custom sidebar templates, maps document names to template names.
   1.109 +#html_sidebars = {}
   1.110 +
   1.111 +# Additional templates that should be rendered to pages, maps page
   1.112 +# names to template names.
   1.113 +#html_additional_pages = {}
   1.114 +
   1.115 +# If false, no module index is generated.
   1.116 +#html_use_modindex = True
   1.117 +
   1.118 +# If true, the reST sources are included in the HTML build as
   1.119 +# _sources/<name>.
   1.120 +#html_copy_source = True
   1.121 +
   1.122 +# Output file base name for HTML help builder.
   1.123 +htmlhelp_basename = 'VIFFdoc'
   1.124 +
   1.125 +
   1.126 +# Options for LaTeX output
   1.127 +# ------------------------
   1.128 +
   1.129 +# The paper size ('letter' or 'a4').
   1.130 +#latex_paper_size = 'letter'
   1.131 +
   1.132 +# The font size ('10pt', '11pt' or '12pt').
   1.133 +#latex_font_size = '10pt'
   1.134 +
   1.135 +# Grouping the document tree into LaTeX files. List of tuples
   1.136 +# (source start file, target name, title, author, document class
   1.137 +# [howto/manual]).
   1.138 +#latex_documents = []
   1.139 +
   1.140 +# Additional stuff for the LaTeX preamble.
   1.141 +#latex_preamble = ''
   1.142 +
   1.143 +# Documents to append as an appendix to all manuals.
   1.144 +#latex_appendices = []
   1.145 +
   1.146 +# If false, no module index is generated.
   1.147 +#latex_use_modindex = True
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/doc/glossary.txt	Tue Apr 22 08:21:11 2008 +0200
     2.3 @@ -0,0 +1,14 @@
     2.4 +
     2.5 +Glossary
     2.6 +========
     2.7 +
     2.8 +.. glossary::
     2.9 +
    2.10 +   Ideal functionality
    2.11 +     An ideal functionality is an uncorruptable party in an ideal
    2.12 +     protocol.
    2.13 +
    2.14 +   VIFF
    2.15 +     Abbreviation for *Virtual Ideal Functionality Framework*. VIFF
    2.16 +     allows you to write programs which behave as if they had access
    2.17 +     to an :term:`ideal functionality`.
     3.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.2 +++ b/doc/index.txt	Tue Apr 22 08:21:11 2008 +0200
     3.3 @@ -0,0 +1,22 @@
     3.4 +
     3.5 +Welcome to VIFF's documentation!
     3.6 +================================
     3.7 +
     3.8 +The Virtual Ideal Functionality Framework is a general framework for
     3.9 +doing secure multi-party computation.
    3.10 +
    3.11 +
    3.12 +Contents:
    3.13 +
    3.14 +.. toctree::
    3.15 +   :maxdepth: 2
    3.16 +
    3.17 +   glossary
    3.18 +
    3.19 +
    3.20 +Indices and tables
    3.21 +==================
    3.22 +
    3.23 +* :ref:`genindex`
    3.24 +* :ref:`modindex`
    3.25 +* :ref:`search`