summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2015-07-22 10:12:09 -0400
committerEli Collins <elic@assurancetechnologies.com>2015-07-22 10:12:09 -0400
commit82f9c816bd2e9f0bf9d7b2dc5efcd839635bd7aa (patch)
tree9ab685b44639b3f98279f5090ea3c91bd6ee72b1 /docs
parent070de8e888ddedd76fbf866ae684430f08131d6d (diff)
downloadpasslib-82f9c816bd2e9f0bf9d7b2dc5efcd839635bd7aa.tar.gz
doc updates
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py10
-rw-r--r--docs/index.rst2
-rw-r--r--docs/install.rst21
3 files changed, 14 insertions, 19 deletions
diff --git a/docs/conf.py b/docs/conf.py
index e63b3d0..dd4640c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -164,13 +164,11 @@ html_theme_options = {}
if csp.is_cloud_theme(html_theme):
html_theme_options.update(roottarget=index_doc,
issueicon=None,
- lighter_decor=True,
-# borderless_decor=True,
- inline_admonitions=False,
+ # lighter_decor=True,
+ borderless_decor=True,
sidebar_localtoc_title="Page contents",
- sidebarwidth="280px",
- max_width="11.5in",
- compact_width="11.5in",
+ max_width="12in",
+ hyphenation_language="en",
)
if 'for-pypi' in options:
html_theme_options.update(
diff --git a/docs/index.rst b/docs/index.rst
index cbcebe3..82c050f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -35,7 +35,7 @@ Content Summary
.. rst-class:: floater
-.. seealso:: :ref:`What's new in Passlib 1.6 <whats-new>`
+.. seealso:: :ref:`What's new in Passlib 1.6.3 <whats-new>`
Introductory Materials
----------------------
diff --git a/docs/install.rst b/docs/install.rst
index 147cb60..3e98992 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -22,16 +22,14 @@ Google App Engine is supported as well.
.. warning::
- **Passlib 1.7 will drop support for Python 2.5,** and require Python 2.6 or newer,
- unless significant feedback is received to reverse the decision.
- Too many core tools such as Setuptools, Pip, and Tox no longer support it,
- making testing increasingly burdensome.
+ **Passlib 1.7 will drop support for Python 2.5, 3.0, and 3.1**;
+ and will require Python 2.6 / 3.2 or newer.
.. _optional-libraries:
Optional Libraries
==================
-* `bcrypt <https://pypi.python.org/pypi/bcrypt>`_ (preferred), or
+* `bcrypt <https://pypi.python.org/pypi/bcrypt>`_,
`py-bcrypt <https://pypi.python.org/pypi/py-bcrypt>`_, or
`bcryptor <https://bitbucket.org/ares/bcryptor/overview>`_
@@ -41,10 +39,13 @@ Optional Libraries
and your OS does not provide native BCrypt support
via stdlib's :mod:`!crypt` (which includes pretty much all non-BSD systems).
+ `bcrypt <https://pypi.python.org/pypi/bcrypt>`_ is currently the recommended
+ option -- it's actively maintained, and compatible with both CPython and PyPy.
+
* `M2Crypto <http://chandlerproject.org/bin/view/Projects/MeTooCrypto>`_
If installed, M2Crypto will be used to accelerate some internal
- functions used by PBKDF2-based hashes, but it is not required
+ functions used by some PBKDF2-based hashes, but it is not required
even in that case.
Installation Instructions
@@ -53,10 +54,6 @@ To install from PyPi using :command:`pip`::
pip install passlib
-To install from PyPi using :command:`easy_install`::
-
- easy_install passlib
-
To install from the source using :command:`setup.py`::
python setup.py install
@@ -95,8 +92,8 @@ online at `<http://packages.python.org/passlib>`_.
If you wish to generate your own copy of the documentation,
you will need to:
-1. Install `Sphinx <http://sphinx.pocoo.org/>`_ (1.1 or newer)
-2. Install the `Cloud Sphinx Theme <http://packages.python.org/cloud_sptheme>`_ (1.6 or newer).
+1. Install `Sphinx <http://sphinx.pocoo.org/>`_ (1.3 or newer)
+2. Install the `Cloud Sphinx Theme <http://packages.python.org/cloud_sptheme>`_ (1.7 or newer).
3. Download the Passlib source
4. From the Passlib source directory, run :samp:`python setup.py build_sphinx`.
5. Once Sphinx completes its run, point a web browser to the file at :samp:`{SOURCE}/build/sphinx/html/index.html`