summaryrefslogtreecommitdiff
path: root/docs/lib
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2011-12-02 15:56:14 -0500
committerEli Collins <elic@assurancetechnologies.com>2011-12-02 15:56:14 -0500
commit35ceb3862ff6ab8187122003421670d263ced591 (patch)
tree7dc8ee9eadd3b5736fa5cef267574e4df8d68986 /docs/lib
parent3a48462b540c1ef47099d0f8dc3feacf564dc74a (diff)
downloadpasslib-35ceb3862ff6ab8187122003421670d263ced591.tar.gz
updated documentation to use some cloud_sptheme 1.3 features
* escaped {} literals in *samp* roles - used on some doc pages * google analytics integration for pypi docs
Diffstat (limited to 'docs/lib')
-rw-r--r--docs/lib/passlib.context-options.rst2
-rw-r--r--docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst4
-rw-r--r--docs/lib/passlib.hash.fshp.rst10
3 files changed, 8 insertions, 8 deletions
diff --git a/docs/lib/passlib.context-options.rst b/docs/lib/passlib.context-options.rst
index 3792da1..629a2b1 100644
--- a/docs/lib/passlib.context-options.rst
+++ b/docs/lib/passlib.context-options.rst
@@ -174,7 +174,7 @@ number of rounds for that scheme, or just a longer verify time.
If an application wishes to use this feature, it all that is needed
is to prefix the name of any hash or context options with the name
of the category string it wants to use, and add an additional separator to the keyword:
-:samp:`{category}__{hash}__{option}`` or ``{category}__context__{option}``.
+:samp:`{category}__{hash}__{option}`` or :samp:`{category}__context__{option}`.
.. note::
diff --git a/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst b/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst
index 1aaa953..4bd4892 100644
--- a/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst
+++ b/docs/lib/passlib.hash.atlassian_pbkdf2_sha1.rst
@@ -33,8 +33,8 @@ Interface
Format & Algorithm
==================
-All of this scheme's hashes have the format :``{PKCS5S2}<data>``,
-where :samp:`<data>` is a 64 character base64 encoded string;
+All of this scheme's hashes have the format :samp:`\\{PKCS5S2\\}{data}`,
+where :samp:`{data}` is a 64 character base64 encoded string;
which (when decoded), contains a 16 byte salt,
and a 32 byte checksum.
diff --git a/docs/lib/passlib.hash.fshp.rst b/docs/lib/passlib.hash.fshp.rst
index 407d7ac..54de676 100644
--- a/docs/lib/passlib.hash.fshp.rst
+++ b/docs/lib/passlib.hash.fshp.rst
@@ -56,24 +56,24 @@ Interface
Format & Algorithm
==================
-All of this scheme's hashes have the format: ``{FSHP<variant>|<saltsize>|<rounds>}<data>``.
+All of this scheme's hashes have the format: :samp:`\\{FSHP{variant}|{saltsize}|{rounds}\\}{data}`.
A example hash (of ``password``) is:
``{FSHP1|16|16384}PtoqcGUetmVEy/uR8715TNqKa8+teMF9qZO1lA9lJNUm1EQBLPZ+qPRLeEPHqy6C``
-* :samp:`<variant>` is a decimal integer identifying the version of FSHP;
+* :samp:`{variant}` is a decimal integer identifying the version of FSHP;
in particular, which cryptographic hash function should be used
to calculate the checksum. ``1`` in the example.
(see the class description above for a list of possible values).
-* :samp:`<saltsize>` is a decimal integer identifying the number of bytes
+* :samp:`{saltsize}` is a decimal integer identifying the number of bytes
in the salt. ``16`` in the example.
-* :samp:`<rounds>` is a decimal integer identifying the number
+* :samp:`{rounds}` is a decimal integer identifying the number
of rounds to apply when calculating the checksum (see below).
``16384`` in the example.
-* :samp:`<data>` is a base64-encoded string which, when decoded,
+* :samp:`{data}` is a base64-encoded string which, when decoded,
contains a salt string of the specified size, followed
by the checksum. In the example, the data portion decodes to
a salt value (in hexdecimal octets) of: