Only use Disqus if the Sphinx tag is set.

Use extlinks extension for download links, bug reports, and mailing
list archives.

Disable devel mode on Disqus.

Fix some broken links detected with Sphinx's linkcheck target.

11 files changed, 58 insertions, 57 deletions

diff --git a/doc/_sphinx/disqus/page.html b/doc/_sphinx/disqus/page.html
index 0ad5db3b7..56e102044 100644
--- a/doc/_sphinx/disqus/page.html
+++ b/doc/_sphinx/disqus/page.html
@@ -6,7 +6,6 @@
 <div id="disqus_thread"></div>
 <script type="text/javascript">
     var disqus_shortname = 'botan';
-    var disqus_developer = 1; // testing mode
 
     var disqus_identifier = 'botan_{{ pagename }}';
     var disqus_url = 'http://botan.randombit.net/{{ pagename }}.html';
diff --git a/doc/conf.py b/doc/conf.py
index 79b8b7efe..167687708 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -15,16 +15,19 @@ import sys, os
 
 sys.path.insert(0, os.pardir)
 
-def is_website_build():
+import sphinx
+
+def check_for_tag(tag):
     # Nasty hack :(
     try:
         opt_t = sys.argv.index('-t')
-        opt_website = sys.argv.index('website')
-        return opt_t + 1 == opt_website
+        opt_tag = sys.argv.index(tag)
+        return opt_t + 1 == opt_tag
     except ValueError:
         return False
 
-is_website_build = is_website_build()
+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__:
@@ -62,14 +65,31 @@ 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 = []
+extensions = ['sphinx.ext.extlinks']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_sphinx/templates']
 
-if is_website_build:
+if is_website_build and use_disqus:
     templates_path += ['_sphinx/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_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_sig': ('http://botan.randombit.net/files/Botan-%s.tbz.asc', 'tar/bzip sig '),
+
+    '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 '),
+
+    'installer_x86_64': ('http://botan.randombit.net/files/win32/botan-%s_win64.exe',
+                         'Windows x86-64 installer ')
+}
+
+
 # The suffix of source filenames.
 source_suffix = '.txt'
 
diff --git a/doc/download.txt b/doc/download.txt
index 185126e19..4d2d68d8a 100644
--- a/doc/download.txt
+++ b/doc/download.txt
@@ -13,58 +13,45 @@ 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 Release (1.11)
-----------------------------------------
+Current Development Series (1.11, branch ``net.randombit.botan``)
+---------------------------------------------------------------------------
 
-The current development release (from branch ``net.randombit.botan``) is
+The latest version of the current development series is
 :doc:`relnotes/1_11_0`
 
+Current Stable Series (1.10, branch ``net.randombit.botan.1_10``)
+---------------------------------------------------------------------------
 
-Current Stable Release (1.10)
-----------------------------------------
-
-The current stable release (from branch ``net.randombit.botan.1_10``)
-is :doc:`relnotes/1_10_2`
-
-Sources:
+The latest version of the current stable series is
+:doc:`relnotes/1_10_2`
 
-`1.10.2 tar/gz <http://botan.randombit.net/files/Botan-1.10.2.tgz>`_
-(`1.10.2 tar/gz sig <http://botan.randombit.net/files/Botan-1.10.2.tgz.asc>`_),
+:tgz:`1.10.2` (:tgz_sig:`1.10.2`)
 
-`1.10.2 tar/bzip <http://botan.randombit.net/files/Botan-1.10.2.tbz>`_
-(`1.10.2 tar/bzip sig <http://botan.randombit.net/files/Botan-1.10.2.tbz.asc>`_)
+:tbz:`1.10.2` (:tbz_sig:`1.10.2`)
 
 ..
   Windows binary installer for use with Visual C++ 2010:
 
-  `1.10.2 x86-32 installer
-  <http://botan.randombit.net/files/win32/botan-1.10.2_win32.exe>`_
-
-  `1.10.2 x86-64 installer
-  <http://botan.randombit.net/files/win32/botan-1.10.2_win64.exe>`_
+  :installer_x86_32:`1.10.2`
 
-Previous Stable Release (1.8)
-----------------------------------------
+  :installer_x86_64:`1.10.2`
 
-The previous stable release (from branch ``net.randombit.botan.1_8``)
-is :doc:`relnotes/1_8_13`
+Previous Stable Series (1.8, branch ``net.randombit.botan.1_8``)
+---------------------------------------------------------------------------
 
-Sources:
+The latest version of the previous stable series is
+:doc:`relnotes/1_8_13`
 
-`1.8.13 tar/gz <http://botan.randombit.net/files/Botan-1.8.13.tgz>`_
-(`1.8.13 tar/gz sig <http://botan.randombit.net/files/Botan-1.8.13.tgz.asc>`_),
+:tgz:`1.8.13` (:tgz_sig:`1.8.13`)
 
-`1.8.13 tar/bzip <http://botan.randombit.net/files/Botan-1.8.13.tbz>`_
-(`1.8.13 tar/bzip sig <http://botan.randombit.net/files/Botan-1.8.13.tbz.asc>`_)
+:tbz:`1.8.13` (:tbz_sig:`1.8.13`)
 
 ..
   Windows binary installer for use with Visual C++ 2008:
 
-  `1.8.13 x86-32 installer
-  <http://botan.randombit.net/files/win32/botan-1.8.13_win32.exe>`_
+  :installer_x86_32:`1.8.13`
 
-  `1.8.13 x86-64 installer
-  <http://botan.randombit.net/files/win32/botan-1.8.13_win64.exe>`_
+  :installer_x86_64:`1.8.13`
 
 Accessing Version Control
 ----------------------------------------
diff --git a/doc/faq.txt b/doc/faq.txt
index e3b85af8e..0101f0cca 100644
--- a/doc/faq.txt
+++ b/doc/faq.txt
@@ -91,9 +91,8 @@ file to be unencrypted, otherwise it will ask you for a new password
 to use.
 
 For unencrypted keys, you can also manually decode the parameters
-using the existing PEM and BER support; see `this post
-<http://lists.randombit.net/pipermail/botan-devel/2010-June/001156.html>`_
-to the dev list for an example.
+using the existing PEM and BER support; see :botan-devel:`this post
+<2010-June/001156>` to the dev list for an example.
 
 Is botan FIPS 140 certified?
 ----------------------------------------
@@ -159,7 +158,7 @@ You can do any combination of:
 
 * Contact the current lead maintainer personally; currently
   `Jack Lloyd <http://www.randombit.net>`_
-  (`personal PGP key <http://www.randombit.net/pgpgkey.html>`_)
+  (`personal PGP key <http://www.randombit.net/keys/pgpkey.html>`_)
 
 * Email the `development list
   <http://lists.randombit.net/mailman/listinfo/botan-devel>`_
diff --git a/doc/index.txt b/doc/index.txt
index 535f8e171..bfb69cd0c 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -35,7 +35,7 @@ of different commercial and open source compilers. The :doc:`build log
 already included in most major package distributions, including
 \
 `Fedora <https://admin.fedoraproject.org/pkgdb/acls/name/botan>`_,
-`EPEL <http://download.fedora.redhat.com/pub/epel/beta/6/SRPMS/repoview/botan.html>`_ (for RHEL/CentOS),
+`EPEL <http://dl.fedoraproject.org/pub/epel/6/SRPMS/repoview/botan.html>`_ (for RHEL/CentOS),
 `Debian <http://packages.debian.org/search?keywords=libbotan>`_,
 `Ubuntu <http://packages.ubuntu.com/search?keywords=botan>`_,
 `Gentoo <http://packages.gentoo.org/package/botan>`_,
diff --git a/doc/relnotes/1_10_1.txt b/doc/relnotes/1_10_1.txt
index 45529e3d5..0620e59a3 100644
--- a/doc/relnotes/1_10_1.txt
+++ b/doc/relnotes/1_10_1.txt
@@ -2,8 +2,8 @@ Version 1.10.1, 2011-07-11
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 * A race condition in `Algorithm_Factory` could cause crashes in
-  multithreaded code. See `this thread on botan-devel
-  <http://lists.randombit.net/pipermail/botan-devel/2011-July/001455.html>`_
+  multithreaded code. See
+  :botan-devel:`this thread on botan-devel <2011-July/001455>`
   for details and workarounds.
 
 * The return value of ``name`` has changed for GOST 28147-89 and
diff --git a/doc/relnotes/1_10_2.txt b/doc/relnotes/1_10_2.txt
index 10cb66176..de52d1115 100644
--- a/doc/relnotes/1_10_2.txt
+++ b/doc/relnotes/1_10_2.txt
@@ -38,7 +38,7 @@ The Qt mutex wrapper was broken and would not compile with any recent
 version of Qt. Taking this as a clear indication that it is not in use,
 it has been removed.
 
-Avoid setting the soname on OpenBSD, as it doesn't support it (PR 158)
+Avoid setting the soname on OpenBSD, as it doesn't support it (:pr:`158`)
 
 A compilation problem in the dynamic loader that prevented using
 dyn_load under MinGW GCC has been fixed.
@@ -56,7 +56,7 @@ searches for an exact match, and only if no exact match is found will
 it search for substring matches.
 
 An incompatability in configure.py with the subprocess module included
-in Python 3.1 has been fixed (PR 157).
+in Python 3.1 has been fixed (:pr:`157`).
 
 The exception catching syntax of configure.py has been changed to the
 Python 3.x syntax. This syntax also works with Python 2.6 and 2.7, but
diff --git a/doc/relnotes/1_8_12.txt b/doc/relnotes/1_8_12.txt
index 83955b7e5..14d29325e 100644
--- a/doc/relnotes/1_8_12.txt
+++ b/doc/relnotes/1_8_12.txt
@@ -10,5 +10,5 @@ Version 1.8.12, 2011-06-20
 * Fix compilation under Sun Studio 12 on Solaris
 
 * Fix a memory leak in the constructors of DataSource_Stream and
-  DataSink_Stream which would occur if opening the file failed. PR 144
+  DataSink_Stream which would occur if opening the file failed (:pr:`144`)
 
diff --git a/doc/relnotes/1_8_13.txt b/doc/relnotes/1_8_13.txt
index 9de12cf07..e96f6e449 100644
--- a/doc/relnotes/1_8_13.txt
+++ b/doc/relnotes/1_8_13.txt
@@ -2,7 +2,6 @@ Version 1.8.13, 2011-07-02
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 * A race condition in `Algorithm_Factory` could cause crashes in
-  multithreaded code. See `this thread on botan-devel
-  <http://lists.randombit.net/pipermail/botan-devel/2011-July/001455.html>`_
-  for details and workarounds.
+  multithreaded code. See :botan-devel:`this thread on botan-devel
+  <2011-July/001455>` for details and workarounds.
 
diff --git a/doc/relnotes/1_9_14.txt b/doc/relnotes/1_9_14.txt
index dec238f3a..c60de26d1 100644
--- a/doc/relnotes/1_9_14.txt
+++ b/doc/relnotes/1_9_14.txt
@@ -7,5 +7,5 @@ Version 1.9.14, 2011-03-01
 * Add support for NIST's AES key wrapping algorithm, as described in
   :rfc:`3394`. It is available by including ``rfc3394.h``.
 
-* Fix an infinite loop in zlib filters introduced in 1.9.11 (PR 142)
+* Fix an infinite loop in zlib filters introduced in 1.9.11 (:pr:`142`)
 
diff --git a/doc/users.txt b/doc/users.txt
index a48d9e60b..fd2a8529b 100644
--- a/doc/users.txt
+++ b/doc/users.txt
@@ -79,9 +79,6 @@ Commercial Software
   uses botan for the drive encryption in the Maxtor OneTouch III Mini
   Edition hard drive.
 
-* `Aegeus Technology Ltd <http://www.aegeus-technology.com>`_ used
-  botan in a research implementation of SPKI.
-
 * `E.V.E. Paradox <http://www.entropicsoftware.com/eve/eve.html>`_, a
   suite of games for Windows.
 
@@ -101,7 +98,7 @@ Research Projects
 
 * The system described in `Enabling Intrusion Detection in IPsec
   Protected IPv6 Networks Through Secret-key Sharing
-  <http://www.stormingmedia.us/01/0151/A015134.pdf>`_
+  <http://www.dtic.mil/dtic/tr/fulltext/u2/a431510.pdf>`_.
 
 * `An experimental tamper detection system
   <http://www.cis.udel.edu/~hiper/passages/papers/jochenMILCOM03.pdf>`_