docs: replaced all "References" sections with "Footnotes" rubric, per Sphinx documentation

26 files changed, 45 insertions, 52 deletions

diff --git a/docs/lib/passlib.apache.rst b/docs/lib/passlib.apache.rst
index 3e12a2d..731baed 100644
--- a/docs/lib/passlib.apache.rst
+++ b/docs/lib/passlib.apache.rst
@@ -55,8 +55,7 @@ in a similar fashion to :class:`HtpasswdFile`.
 
 .. autoclass:: HtdigestFile(path, autoload=True)
 
-References
-==========
+.. rubric:: Footnotes
 
 .. [#] Htpasswd Manual - `<http://httpd.apache.org/docs/current/programs/htpasswd.html>`_
 
diff --git a/docs/lib/passlib.hash.apr_md5_crypt.rst b/docs/lib/passlib.hash.apr_md5_crypt.rst
index a9951f4..6ae5361 100644
--- a/docs/lib/passlib.hash.apr_md5_crypt.rst
+++ b/docs/lib/passlib.hash.apr_md5_crypt.rst
@@ -34,7 +34,7 @@ to the original MD5-Crypt, except for two changes:
    Because of this change, even raw checksums generated by apr-md5-crypt and md5-crypt
    are not compatible with eachother.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#] Apache's description of Apr-MD5-Crypt -
        `<http://httpd.apache.org/docs/2.2/misc/password_encryptions.html>`_
diff --git a/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst b/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst
index a2a0a05..1aaa953 100644
--- a/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst
+++ b/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst
@@ -56,6 +56,6 @@ Using the specified salt, and a fixed 10000 rounds,
 PBKDF2-HMAC-SHA1 is used to generate a 32 byte key,
 which appended to the salt and encoded in base64.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#pbkdf2] The specification for the PBKDF2 algorithm - `<http://tools.ietf.org/html/rfc2898#section-5.2>`_.
diff --git a/docs/lib/passlib.hash.bcrypt.rst b/docs/lib/passlib.hash.bcrypt.rst
index efa2098..ccc7c7b 100644
--- a/docs/lib/passlib.hash.bcrypt.rst
+++ b/docs/lib/passlib.hash.bcrypt.rst
@@ -65,6 +65,6 @@ This implementation of bcrypt differs from others in a few ways:
   encoding is desired by an application, the password should be encoded
   before handing it to PassLib.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#f1] `<http://www.usenix.org/event/usenix99/provos/provos_html/>`_ - the bcrypt format specification
diff --git a/docs/lib/passlib.hash.bigcrypt.rst b/docs/lib/passlib.hash.bigcrypt.rst
index 6431e5e..4106a71 100644
--- a/docs/lib/passlib.hash.bigcrypt.rst
+++ b/docs/lib/passlib.hash.bigcrypt.rst
@@ -132,7 +132,7 @@ This implementation of bigcrypt differs from others in two ways:
   encoding is desired by an application, the password should be encoded
   before handing it to PassLib.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#] discussion of bigcrypt & crypt16 -
        `<http://www.mail-archive.com/exim-dev@exim.org/msg00970.html>`_
diff --git a/docs/lib/passlib.hash.bsdi_crypt.rst b/docs/lib/passlib.hash.bsdi_crypt.rst
index bd2d334..bb3aa92 100644
--- a/docs/lib/passlib.hash.bsdi_crypt.rst
+++ b/docs/lib/passlib.hash.bsdi_crypt.rst
@@ -131,8 +131,8 @@ This implementation of bsdi-crypt differs from others in one way:
   encoding is desired by an application, the password should be encoded
   before handing it to PassLib.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#] Primary source used for description of bsdi-crypt format & algorithm -
        `<http://fuse4bsd.creo.hu/localcgi/man-cgi.cgi?crypt+3>`_
 
diff --git a/docs/lib/passlib.hash.crypt16.rst b/docs/lib/passlib.hash.crypt16.rst
index 8696479..28c5424 100644
--- a/docs/lib/passlib.hash.crypt16.rst
+++ b/docs/lib/passlib.hash.crypt16.rst
@@ -112,7 +112,7 @@ This implementation of crypt16 deviates from public documentation of the format
   encoding is desired by an application, the password should be encoded
   before handing it to PassLib.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#] One source of information about bigcrypt & crypt16 -
        `<http://www.mail-archive.com/exim-dev@exim.org/msg00970.html>`_
diff --git a/docs/lib/passlib.hash.cta_pbkdf2_sha1.rst b/docs/lib/passlib.hash.cta_pbkdf2_sha1.rst
index 526c408..a4d8d54 100644
--- a/docs/lib/passlib.hash.cta_pbkdf2_sha1.rst
+++ b/docs/lib/passlib.hash.cta_pbkdf2_sha1.rst
@@ -62,8 +62,7 @@ the specified number of rounds, and using HMAC-SHA1 as it's psuedorandom functio
 20 bytes of derived key are requested, and the resulting key is encoded and used
 as the checksum portion of the hash.
 
-References
-==========
+.. rubric:: Footnotes
 
 .. [#cta] The reference for this hash format - `<https://bitbucket.org/dholth/cryptacular/>`_.
 
diff --git a/docs/lib/passlib.hash.des_crypt.rst b/docs/lib/passlib.hash.des_crypt.rst
index 5893da4..06d4f85 100644
--- a/docs/lib/passlib.hash.des_crypt.rst
+++ b/docs/lib/passlib.hash.des_crypt.rst
@@ -133,6 +133,6 @@ This implementation of des-crypt differs from others in a few ways:
   encoding is desired by an application, the password should be encoded
   before handing it to PassLib.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#] A java implementation of des-crypt, used as base for PassLib's pure-python implementation, is located at `<http://www.dynamic.net.au/christos/crypt/UnixCrypt2.txt>`_
diff --git a/docs/lib/passlib.hash.dlitz_pbkdf2_sha1.rst b/docs/lib/passlib.hash.dlitz_pbkdf2_sha1.rst
index d92a82b..794e506 100644
--- a/docs/lib/passlib.hash.dlitz_pbkdf2_sha1.rst
+++ b/docs/lib/passlib.hash.dlitz_pbkdf2_sha1.rst
@@ -61,8 +61,7 @@ the specified number of rounds, and using HMAC-SHA1 as it's psuedorandom functio
 24 bytes of derived key are requested, and the resulting key is encoded and used
 as the checksum portion of the hash.
 
-References
-==========
+.. rubric:: Footnotes
 
 .. [#dlitz] The reference for this hash format - `<http://www.dlitz.net/software/python-pbkdf2/>`_.
 
diff --git a/docs/lib/passlib.hash.fshp.rst b/docs/lib/passlib.hash.fshp.rst
index 95f52fb..fe1ffdf 100644
--- a/docs/lib/passlib.hash.fshp.rst
+++ b/docs/lib/passlib.hash.fshp.rst
@@ -122,8 +122,8 @@ Deviations
   encoding is desired by an application, the password should be encoded
   before handing it to PassLib.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#home] The FSHP homepage contains implementations in a wide variety of
            programming languages -- `<https://github.com/bdd/fshp-is-not-secure-anymore>`_.
 
diff --git a/docs/lib/passlib.hash.grub_pbkdf2_sha512.rst b/docs/lib/passlib.hash.grub_pbkdf2_sha512.rst
index bde4f70..a8b18c8 100644
--- a/docs/lib/passlib.hash.grub_pbkdf2_sha512.rst
+++ b/docs/lib/passlib.hash.grub_pbkdf2_sha512.rst
@@ -76,8 +76,7 @@ The result is then encoded into hexidecimal.
         >>> grub_pbkdf2_sha512.verify("password", g)
         True
 
-References
-==========
+.. rubric:: Footnotes
 
 .. [#grub] Information about Grub's password hashes - `<http://grub.enbug.org/Authentication>`_.
 
diff --git a/docs/lib/passlib.hash.ldap_crypt.rst b/docs/lib/passlib.hash.ldap_crypt.rst
index 04e6f93..cded54a 100644
--- a/docs/lib/passlib.hash.ldap_crypt.rst
+++ b/docs/lib/passlib.hash.ldap_crypt.rst
@@ -65,8 +65,7 @@ Interface
     natively by your host OS, use an test such as
     ``ldap_des_crypt.has_backend("os_crypt")`` or similar.
 
-References
-==========
+.. rubric:: Footnotes
 
 .. [#pwd] The manpage for :command:`slappasswd` - `<http://gd.tuwien.ac.at/linuxcommand.org/man_pages/slappasswd8.html>`_.
 
diff --git a/docs/lib/passlib.hash.ldap_other.rst b/docs/lib/passlib.hash.ldap_other.rst
index bd0200b..abbd900 100644
--- a/docs/lib/passlib.hash.ldap_other.rst
+++ b/docs/lib/passlib.hash.ldap_other.rst
@@ -43,7 +43,6 @@ Other Hashes
 
     an example hash (of ``password``) is ``{plaintext}password``.
 
-References
-==========
+.. rubric:: Footnotes
 
 .. [#roundup] Roundup Issue Tracker homepage - `<http://www.roundup-tracker.org>`_.
diff --git a/docs/lib/passlib.hash.ldap_pbkdf2_digest.rst b/docs/lib/passlib.hash.ldap_pbkdf2_digest.rst
index d734960..822f8a9 100644
--- a/docs/lib/passlib.hash.ldap_pbkdf2_digest.rst
+++ b/docs/lib/passlib.hash.ldap_pbkdf2_digest.rst
@@ -32,7 +32,7 @@ Interface
     this is the same as :class:`pbkdf2_sha512`, except that it
     uses ``{PBKDF2-SHA512}`` as it's identifying prefix instead of ``$pdkdf2-sha512$``.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#pbkdf2] The specification for the PBKDF2 algorithm - `<http://tools.ietf.org/html/rfc2898#section-5.2>`_,
              part of :rfc:`2898`.
diff --git a/docs/lib/passlib.hash.md5_crypt.rst b/docs/lib/passlib.hash.md5_crypt.rst
index 0644ddb..03681c2 100644
--- a/docs/lib/passlib.hash.md5_crypt.rst
+++ b/docs/lib/passlib.hash.md5_crypt.rst
@@ -166,8 +166,8 @@ PassLib's implementation of md5-crypt differs from the reference implementation
   encoding is desired by an application, the password should be encoded
   before handing it to PassLib.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#f1] The authoritative reference for MD5-Crypt is Poul-Henning Kamp's original
          FreeBSD implementation -
          `<http://www.freebsd.org/cgi/cvsweb.cgi/~checkout~/src/lib/libcrypt/crypt.c?rev=1.2>`_
diff --git a/docs/lib/passlib.hash.mysql323.rst b/docs/lib/passlib.hash.mysql323.rst
index d6ff729..4e226e9 100644
--- a/docs/lib/passlib.hash.mysql323.rst
+++ b/docs/lib/passlib.hash.mysql323.rst
@@ -64,8 +64,8 @@ Lacking any sort of salt, ignoring all whitespace,
 and having a simplistic algorithm amounts to little more than a checksum,
 this is not secure, and should not be used for *any* purpose but verifying existing MySQL 3.2.3 - 4.0 password hashes.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#f1] Source of implementation used by passlib -
          `<http://djangosnippets.org/snippets/1508/>`_
 
diff --git a/docs/lib/passlib.hash.oracle10.rst b/docs/lib/passlib.hash.oracle10.rst
index 06941ff..ac79741 100644
--- a/docs/lib/passlib.hash.oracle10.rst
+++ b/docs/lib/passlib.hash.oracle10.rst
@@ -106,8 +106,8 @@ There is only one known issue:
   This note applies as well to any provided username,
   as they are run through the same policy.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#enc] The exact encoding used in step 3 of the algorithm is not clear from known references.
           PassLib uses ``utf-16-be``, as this is both compatible with existing test vectors
           and supports unicode input.
diff --git a/docs/lib/passlib.hash.oracle11.rst b/docs/lib/passlib.hash.oracle11.rst
index 09fef12..c879bc0 100644
--- a/docs/lib/passlib.hash.oracle11.rst
+++ b/docs/lib/passlib.hash.oracle11.rst
@@ -78,7 +78,7 @@ There is only one known issue:
   This behavior may be altered in the future, if further testing
   reveals another behavior is more in line with the official representation.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#] Description of Oracle10g and Oracle11g algorithms -
        `<http://www.notesbit.com/index.php/scripts-oracle/oracle-11g-new-password-algorithm-is-revealed-by-seclistsorg/>`_.
diff --git a/docs/lib/passlib.hash.pbkdf2_digest.rst b/docs/lib/passlib.hash.pbkdf2_digest.rst
index 64c9b3a..0f2b1c6 100644
--- a/docs/lib/passlib.hash.pbkdf2_digest.rst
+++ b/docs/lib/passlib.hash.pbkdf2_digest.rst
@@ -81,8 +81,8 @@ along with the decoded salt, the number of rounds,
 and a prf built from HMAC + the respective message digest.
 The result is then encoded using :func:`~passlib.utils.adapted_b64_encode`.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#pbkdf2] The specification for the PBKDF2 algorithm - `<http://tools.ietf.org/html/rfc2898#section-5.2>`_,
              part of :rfc:`2898`.
 
diff --git a/docs/lib/passlib.hash.phpass.rst b/docs/lib/passlib.hash.phpass.rst
index 46378c5..20a3bb0 100644
--- a/docs/lib/passlib.hash.phpass.rst
+++ b/docs/lib/passlib.hash.phpass.rst
@@ -71,7 +71,7 @@ This implementation of phpass differs from the specification in one way:
   encoding is desired by an application, the password should be encoded
   before handing it to PassLib.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#pp] PHPass homepage, which describes the Portable Hash algorithm -
          `<http://www.openwall.com/phpass/>`_
diff --git a/docs/lib/passlib.hash.postgres_md5.rst b/docs/lib/passlib.hash.postgres_md5.rst
index 9d8d7ab..6bafbed 100644
--- a/docs/lib/passlib.hash.postgres_md5.rst
+++ b/docs/lib/passlib.hash.postgres_md5.rst
@@ -64,8 +64,8 @@ PostgreSQL account passwords, due to the following flaws:
 
 * It's simplicity makes high-speed brute force attacks much more feasible [#brute]_ .
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#] Discussion leading up to design of algorithm -
        `<http://archives.postgresql.org/pgsql-hackers/2001-06/msg00952.php>`_
 
diff --git a/docs/lib/passlib.hash.sha1_crypt.rst b/docs/lib/passlib.hash.sha1_crypt.rst
index 6f26bb2..cae9c42 100644
--- a/docs/lib/passlib.hash.sha1_crypt.rst
+++ b/docs/lib/passlib.hash.sha1_crypt.rst
@@ -97,8 +97,8 @@ in a few ways:
   encoding is desired by an application, the password should be encoded
   before handing it to PassLib.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#desc] description of sha1-crypt algorithm -
            `<http://mail-index.netbsd.org/tech-userlevel/2004/05/29/0001.html>`_
 
diff --git a/docs/lib/passlib.hash.sha512_crypt.rst b/docs/lib/passlib.hash.sha512_crypt.rst
index 90f0812..db727c9 100644
--- a/docs/lib/passlib.hash.sha512_crypt.rst
+++ b/docs/lib/passlib.hash.sha512_crypt.rst
@@ -108,6 +108,6 @@ and other implementations, in a few ways:
   encoding is desired by an application, the password should be encoded
   before handing it to PassLib.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#f1] Ulrich Drepper's SHA-256/512-Crypt specification, reference implementation, and test vectors - `sha-crypt specification <http://www.akkadia.org/drepper/sha-crypt.html>`_
diff --git a/docs/lib/passlib.hash.sun_md5_crypt.rst b/docs/lib/passlib.hash.sun_md5_crypt.rst
index 308e5b4..b3b891a 100644
--- a/docs/lib/passlib.hash.sun_md5_crypt.rst
+++ b/docs/lib/passlib.hash.sun_md5_crypt.rst
@@ -189,8 +189,8 @@ Solaris environment. Issues of concern include:
 * More information is needed about the parsing / formatting issue described
   in the :ref:`smc-bare-salt` section.
 
-References
-==========
+.. rubric:: Footnotes
+
 .. [#mct] Overview of & motivations for the algorithm - `<http://dropsafe.crypticide.com/article/1389>`_
 
 .. [#f2] The source of Hamlet's speech, used byte-for-byte as the constant data - `<http://www.ibiblio.org/pub/docs/books/gutenberg/etext98/2ws2610.txt>`_
diff --git a/docs/lib/passlib.hosts.rst b/docs/lib/passlib.hosts.rst
index 08538fd..c03bbed 100644
--- a/docs/lib/passlib.hosts.rst
+++ b/docs/lib/passlib.hosts.rst
@@ -104,7 +104,6 @@ Current Host OS
         This object is only available on systems where the stdlib :mod:`!crypt` module is present.
         In version 1.3 and earlier, it was available on non-Unix systems, though it did nothing useful.
 
-References
-==========
+.. rubric:: Footnotes
 
 .. [#shadow] Man page for Linux /etc/shadow - `<http://linux.die.net/man/5/shadow>`_