diff options
| -rw-r--r-- | doc/conf.py | 66 | ||||
| -rw-r--r-- | doc/contents.txt | 4 | ||||
| -rw-r--r-- | doc/download.txt | 50 |
3 files changed, 38 insertions, 82 deletions
diff --git a/doc/conf.py b/doc/conf.py index 167687708..697fa01b7 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,21 +1,15 @@ -# -*- coding: utf-8 -*- -# -# botan documentation build configuration file, created by -# sphinx-quickstart on Sun Apr 3 11:41:06 2011. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. +# Sphinx configuration file import sys, os +# Avoid useless botan_version.pyc (Python 2.6 or higher) +if 'dont_write_bytecode' in sys.__dict__: + sys.dont_write_bytecode = True + sys.path.insert(0, os.pardir) import sphinx +import botan_version def check_for_tag(tag): # Nasty hack :( @@ -29,20 +23,6 @@ def check_for_tag(tag): is_website_build = check_for_tag('website') use_disqus = is_website_build and check_for_tag('disqus') -# Avoid useless botan_version.pyc (Python 2.6 or higher) -if 'dont_write_bytecode' in sys.__dict__: - sys.dont_write_bytecode = True - -import botan_version - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. needs_sphinx = '1.0' """ @@ -58,16 +38,12 @@ def check_sphinx_version(): if version[0] == 1 and version[1] == 0 and version[2] < 7: # Exit rather than throwing to avoid a confusing backtrace print "This Sphinx is too old - upgrade to at least 1.0.7" - import sys sys.exit(1) check_sphinx_version() -# 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.extlinks'] -# Add any paths that contain templates here, relative to this directory. templates_path = ['_sphinx/templates'] if is_website_build and use_disqus: @@ -75,53 +51,38 @@ if is_website_build and use_disqus: extlinks = { 'pr': ('http://bugs.randombit.net/show_bug.cgi?id=%s', 'PR '), - 'tgz': ('http://botan.randombit.net/files/Botan-%s.tgz', 'tar/gz '), + 'tgz': ('http://botan.randombit.net/files/Botan-%s.tgz', 'tar/gz for '), 'tgz_sig': ('http://botan.randombit.net/files/Botan-%s.tgz.asc', 'tar/gz sig '), - 'tbz': ('http://botan.randombit.net/files/Botan-%s.tbz', 'tar/bzip '), + 'tbz': ('http://botan.randombit.net/files/Botan-%s.tbz', 'tar/bzip for '), 'tbz_sig': ('http://botan.randombit.net/files/Botan-%s.tbz.asc', 'tar/bzip sig '), + 'viewmtn': ('http://viewmtn.randombit.net/tree/h:%s', ''), + 'botan-devel': ('http://lists.randombit.net/pipermail/botan-devel/%s.html', None), 'installer_x86_32': ('http://botan.randombit.net/files/win32/botan-%s_win32.exe', - 'Windows x86-32 installer '), + 'x86-32 '), 'installer_x86_64': ('http://botan.randombit.net/files/win32/botan-%s_win64.exe', - 'Windows x86-64 installer ') + 'x86-64 ') } - -# The suffix of source filenames. source_suffix = '.txt' -# The encoding of source files. source_encoding = 'utf-8-sig' -# The master toctree document. master_doc = 'contents' -# General information about the project. project = u'botan' copyright = u'2000-2012, Jack Lloyd' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. version = '%d.%d' % (botan_version.release_major, botan_version.release_minor) -# The full version, including alpha/beta/rc tags. + release = '%d.%d.%d' % (botan_version.release_major, botan_version.release_minor, botan_version.release_patch) -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: #today = '' -# Else, today_fmt is used as the format for a strftime call. today_fmt = '%Y-%m-%d' # List of patterns, relative to source directory, that match files and @@ -239,7 +200,6 @@ else: # Output file base name for HTML help builder. htmlhelp_basename = 'botandoc' - # -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). diff --git a/doc/contents.txt b/doc/contents.txt index 75286c945..835fabf82 100644 --- a/doc/contents.txt +++ b/doc/contents.txt @@ -7,6 +7,8 @@ Contents index reading + faq + download building firststep filters @@ -30,10 +32,8 @@ Contents license credits - faq users support - download pgpkey algos build_log diff --git a/doc/download.txt b/doc/download.txt index 4d2d68d8a..2072ee88e 100644 --- a/doc/download.txt +++ b/doc/download.txt @@ -13,45 +13,41 @@ Unsure which release you want? Check the :ref:`FAQ <devel_vs_stable>`. If you are viewing this documentation offline, a more recent release `may be available <http://botan.randombit.net/download.html>`_. -Current Development Series (1.11, branch ``net.randombit.botan``) +Current Development Series (1.11) --------------------------------------------------------------------------- -The latest version of the current development series is -:doc:`relnotes/1_11_0` +The latest version of the current development series, from branch +``net.randombit.botan``, is :doc:`relnotes/1_11_0` -Current Stable Series (1.10, branch ``net.randombit.botan.1_10``) +Current Stable Series (1.10) --------------------------------------------------------------------------- -The latest version of the current stable series is -:doc:`relnotes/1_10_2` +The latest version of the current stable series, from branch +``net.randombit.botan.1_10``, is :doc:`relnotes/1_10_2`: +:tgz:`1.10.2` (:tgz_sig:`sig <1.10.2>`), +:tbz:`1.10.2` (:tbz_sig:`sig <1.10.2>`) -:tgz:`1.10.2` (:tgz_sig:`1.10.2`) +Windows Installer +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:tbz:`1.10.2` (:tbz_sig:`1.10.2`) +Windows installers for :installer_x86_32:`1.10.1` and +:installer_x86_64:`1.10.1` for use with Visual C++ 2010 are +also available. -.. - Windows binary installer for use with Visual C++ 2010: - - :installer_x86_32:`1.10.2` - - :installer_x86_64:`1.10.2` - -Previous Stable Series (1.8, branch ``net.randombit.botan.1_8``) +Previous Stable Series (1.8) --------------------------------------------------------------------------- -The latest version of the previous stable series is -:doc:`relnotes/1_8_13` - -:tgz:`1.8.13` (:tgz_sig:`1.8.13`) - -:tbz:`1.8.13` (:tbz_sig:`1.8.13`) - -.. - Windows binary installer for use with Visual C++ 2008: +The latest version of the previous stable series, from branch +``net.randombit.botan.1_8`` is :doc:`relnotes/1_8_13`: +:tgz:`1.8.13` (:tgz_sig:`sig <1.8.13>`), +:tbz:`1.8.13` (:tbz_sig:`sig <1.8.13>`) - :installer_x86_32:`1.8.13` +Windows Installer +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - :installer_x86_64:`1.8.13` +Windows installers for :installer_x86_32:`1.8.11` and +:installer_x86_64:`1.8.11` for use with Visual C++ 2008 are also +available. Accessing Version Control ---------------------------------------- |