Merge branch '1.10' into sphinx-256

6 files changed, 64 insertions, 40 deletions

diff --git a/sites/shared_conf.py b/sites/shared_conf.py
index 89e0a56d..86ecdfe8 100644
--- a/sites/shared_conf.py
+++ b/sites/shared_conf.py
@@ -5,14 +5,13 @@ import sys
 import alabaster
 
 
-# Alabaster theme
+# Alabaster theme + mini-extension
 html_theme_path = [alabaster.get_path()]
+extensions = ['alabaster']
 # Paths relative to invoking conf.py - not this shared file
 html_static_path = ['../_shared_static']
 html_theme = 'alabaster'
 html_theme_options = {
-    'logo': 'logo.png',
-    'logo_name': 'true',
     'description': "A Python implementation of SSHv2.",
     'github_user': 'paramiko',
     'github_repo': 'paramiko',
@@ -21,19 +20,11 @@ html_theme_options = {
 
     'link': '#3782BE',
     'link_hover': '#3782BE',
-
 }
 html_sidebars = {
-    # Landing page (no ToC)
-    'index': [
-        'about.html',
-        'searchbox.html',
-        'donate.html',
-    ],
-    # Inner pages get a ToC
     '**': [
         'about.html',
-        'localtoc.html',
+        'navigation.html',
         'searchbox.html',
         'donate.html',
     ]
@@ -42,7 +33,7 @@ html_sidebars = {
 # Regular settings
 project = u'Paramiko'
 year = datetime.now().year
-copyright = u'%d Jeff Forcier, 2003-2012 Robey Pointer' % year
+copyright = u'%d Jeff Forcier' % year
 master_doc = 'index'
 templates_path = ['_templates']
 exclude_trees = ['_build']
diff --git a/sites/www/changelog.rst b/sites/www/changelog.rst
index bba78949..fa58c5f6 100644
--- a/sites/www/changelog.rst
+++ b/sites/www/changelog.rst
@@ -2,8 +2,15 @@
 Changelog
 =========
 
-* :release:`1.10.6 <2014-01-21>`
-* :bug:`193` (and its attentant PRs :issue:`230` & :issue:`253`): Fix SSH agent
+* :bug:`-` Use constant-time hash comparison operations where possible, to
+  protect against `timing-based attacks
+  <http://codahale.com/a-lesson-in-timing-attacks/>`_. Thanks to Alex Gaynor
+  for the patch.
+* :release:`1.10.6 <2014-02-14>`
+* :bug:`34` (PR :issue:`35`) Fix SFTP prefetching incompatibility with some
+  SFTP servers regarding request/response ordering. Thanks to Richard
+  Kettlewell for catch & patch.
+* :bug:`193` (and its attentant PRs :issue:`230` & :issue:`253`) Fix SSH agent
   problems present on Windows. Thanks to David Hobbs for initial report and to
   Aarni Koskela & Olle Lundberg for the patches.
 * :release:`1.10.5 <2014-01-08>`
@@ -14,7 +21,7 @@ Changelog
 * :bug:`179` Fix a missing variable causing errors when an ssh_config file has
   a non-default AddressFamily set. Thanks to Ed Marshall & Tomaz Muraus for
   catch & patch.
-* :bug:`200` Fix an exception-causing typo in `demo_simple.py`. Thanks to Alex
+* :bug:`200` Fix an exception-causing typo in ``demo_simple.py``. Thanks to Alex
   Buchanan for catch & Dave Foster for patch.
 * :bug:`199` Typo fix in the license header cross-project. Thanks to Armin
   Ronacher for catch & patch.
@@ -27,7 +34,7 @@ Changelog
   and 'remoteforward' keys. Thanks to Emre Yılmaz for the patch.
 * :release:`1.10.2 <2013-07-26>`
 * :bug:`153` (also :issue:`67`) Warn on parse failure when reading known_hosts
-  file.  Thanks to `@glasserc` for patch.
+  file.  Thanks to ``@glasserc`` for patch.
 * :bug:`146` Indentation fixes for readability. Thanks to Abhinav Upadhyay for
   catch & patch.
 * :release:`1.10.1 <2013-04-05>`
@@ -46,32 +53,32 @@ Changelog
   attempt to wait for a response from the remote sshd; this fixes problems with
   less common targets such as some Cisco devices. Thanks to Phillip Heller for
   catch & patch.
-* :feature:`93` Overhaul SSH config parsing to be in line with `man
-  ssh_config` (& the behavior of `ssh` itself), including addition of parameter
+* :feature:`93` Overhaul SSH config parsing to be in line with ``man
+  ssh_config`` (& the behavior of ``ssh`` itself), including addition of parameter
   expansion within config values. Thanks to Olle Lundberg for the patch.
-* :feature:`110` Honor SSH config `AddressFamily` setting when looking up
+* :feature:`110` Honor SSH config ``AddressFamily`` setting when looking up
   local host's FQDN. Thanks to John Hensley for the patch.
 * :feature:`128` Defer FQDN resolution until needed, when parsing SSH config
   files.  Thanks to Parantapa Bhattacharya for catch & patch.
 * :bug:`102 major` Forego random padding for packets when running under
-  `*-ctr` ciphers.  This corrects some slowdowns on platforms where random byte
-  generation is inefficient (e.g. Windows). Thanks to  `@warthog618` for catch
-  & patch, and Michael van der Kolff for code/technique review.
-* :feature:`127` Turn `SFTPFile` into a context manager. Thanks to Michael
+  ``*-ctr`` ciphers.  This corrects some slowdowns on platforms where random
+  byte generation is inefficient (e.g. Windows). Thanks to  ``@warthog618`` for
+  catch & patch, and Michael van der Kolff for code/technique review.
+* :feature:`127` Turn ``SFTPFile`` into a context manager. Thanks to Michael
   Williamson for the patch.
-* :feature:`116` Limit `Message.get_bytes` to an upper bound of 1MB to protect
-  against potential DoS vectors. Thanks to `@mvschaik` for catch & patch.
-* :feature:`115` Add convenience `get_pty` kwarg to `Client.exec_command` so
+* :feature:`116` Limit ``Message.get_bytes`` to an upper bound of 1MB to protect
+  against potential DoS vectors. Thanks to ``@mvschaik`` for catch & patch.
+* :feature:`115` Add convenience ``get_pty`` kwarg to ``Client.exec_command`` so
   users not manually controlling a channel object can still toggle PTY
   creation. Thanks to Michael van der Kolff for the patch.
-* :feature:`71` Add `SFTPClient.putfo` and `.getfo` methods to allow direct
+* :feature:`71` Add ``SFTPClient.putfo`` and ``.getfo`` methods to allow direct
   uploading/downloading of file-like objects. Thanks to Eric Buehl for the
   patch.
-* :feature:`113` Add `timeout` parameter to `SSHClient.exec_command` for
+* :feature:`113` Add ``timeout`` parameter to ``SSHClient.exec_command`` for
   easier setting of the command's internal channel object's timeout. Thanks to
   Cernov Vladimir for the patch.
 * :support:`94` Remove duplication of SSH port constant. Thanks to Olle
   Lundberg for the catch.
 * :feature:`80` Expose the internal "is closed" property of the file transfer
-  class `BufferedFile` as `.closed`, better conforming to Python's file
-  interface.  Thanks to `@smunaut` and James Hiscock for catch & patch.
+  class ``BufferedFile`` as ``.closed``, better conforming to Python's file
+  interface.  Thanks to ``@smunaut`` and James Hiscock for catch & patch.
diff --git a/sites/www/conf.py b/sites/www/conf.py
index c144b5b4..481acdff 100644
--- a/sites/www/conf.py
+++ b/sites/www/conf.py
@@ -1,15 +1,35 @@
 # Obtain shared config values
-import os, sys
-sys.path.append(os.path.abspath('..'))
+import sys
+import os
+from os.path import abspath, join, dirname
+
+sys.path.append(abspath(join(dirname(__file__), '..')))
 from shared_conf import *
 
-# Add local blog extension
-sys.path.append(os.path.abspath('.'))
-extensions = ['blog']
+# Local blog extension
+sys.path.append(abspath('.'))
+extensions.append('blog')
 rss_link = 'http://paramiko.org'
 rss_description = 'Paramiko project news'
 
-# Add Releases changelog extension
+# Releases changelog extension
 extensions.append('releases')
 releases_release_uri = "https://github.com/paramiko/paramiko/tree/%s"
 releases_issue_uri = "https://github.com/paramiko/paramiko/issues/%s"
+
+# Intersphinx for referencing API/usage docs
+extensions.append('sphinx.ext.intersphinx')
+# Default is 'local' building, but reference the public docs site when building
+# under RTD.
+target = join(dirname(__file__), '..', 'docs', '_build')
+if os.environ.get('READTHEDOCS') == 'True':
+    # TODO: switch to docs.paramiko.org post go-live of sphinx API docs
+    target = 'http://paramiko-docs.readthedocs.org/en/latest/'
+#intersphinx_mapping = {
+#    'docs': (target, None),
+#}
+
+# Sister-site links to API docs
+html_theme_options['extra_nav_links'] = {
+    "API Docs": 'http://docs.paramiko.org',
+}
diff --git a/sites/www/contact.rst b/sites/www/contact.rst
index b479f170..2b6583f5 100644
--- a/sites/www/contact.rst
+++ b/sites/www/contact.rst
@@ -8,4 +8,4 @@ following ways:
 * IRC: ``#paramiko`` on Freenode
 * Mailing list: ``paramiko@librelist.com`` (see `the LibreList homepage
   <http://librelist.com>`_ for usage details).
-* This website's :doc:`blog </blog>`.
+* This website - a blog section is forthcoming.
diff --git a/sites/www/contributing.rst b/sites/www/contributing.rst
index b121e64b..2b752cc5 100644
--- a/sites/www/contributing.rst
+++ b/sites/www/contributing.rst
@@ -6,7 +6,7 @@ How to get the code
 ===================
 
 Our primary Git repository is on Github at `paramiko/paramiko
-<https://github.com/paramiko/paramiko>`; please follow their instruction for
+<https://github.com/paramiko/paramiko>`_; please follow their instructions for
 cloning to your local system. (If you intend to submit patches/pull requests,
 we recommend forking first, then cloning your fork. Github has excellent
 documentation for all this.)
diff --git a/sites/www/index.rst b/sites/www/index.rst
index f8db6fd0..7fefedd2 100644
--- a/sites/www/index.rst
+++ b/sites/www/index.rst
@@ -12,12 +12,18 @@ usage and API documentation can be found at our code documentation site,
 `docs.paramiko.org <http://docs.paramiko.org>`_.
 
 .. toctree::
-    blog
     changelog
     installing
     contributing
     contact
 
+.. Hide blog in hidden toctree for now (to avoid warnings.)
+
+.. toctree::
+    :hidden:
+
+    blog
+
 
 .. rubric:: Footnotes