summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2016-11-23 09:49:02 -0500
committerEli Collins <elic@assurancetechnologies.com>2016-11-23 09:49:02 -0500
commit13d930dd7da35ecd9e158cf49696d4ee073d385c (patch)
tree5b561f8b3bccc6ba2cf71ed8a56998156b064cdc /docs
parente17b0f4e34a2b8f2e3dc8169d789289fe426650a (diff)
downloadpasslib-13d930dd7da35ecd9e158cf49696d4ee073d385c.tar.gz
docs: tweaks to layout, added warning for pythonhosted docs
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py2
-rw-r--r--docs/history/1.5.rst6
-rw-r--r--docs/history/1.6.rst6
-rw-r--r--docs/history/1.7.rst11
-rw-r--r--docs/history/ancient.rst6
-rw-r--r--docs/history/index.rst35
-rw-r--r--docs/index.rst11
7 files changed, 50 insertions, 27 deletions
diff --git a/docs/conf.py b/docs/conf.py
index b45d17a..7adac8b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -109,6 +109,8 @@ from passlib import __version__ as release
version = csp.get_version(release)
if ".dev" in release:
tags.add("devcopy")
+if 'for-pypi' in options:
+ tags.add("pypi")
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/docs/history/1.5.rst b/docs/history/1.5.rst
index 575e81b..9d4135c 100644
--- a/docs/history/1.5.rst
+++ b/docs/history/1.5.rst
@@ -1,6 +1,6 @@
-==========
-1.5 Series
-==========
+===========
+Passlib 1.5
+===========
.. _bcrypt-padding-issue:
diff --git a/docs/history/1.6.rst b/docs/history/1.6.rst
index 6b88c4b..1406b5f 100644
--- a/docs/history/1.6.rst
+++ b/docs/history/1.6.rst
@@ -1,6 +1,6 @@
-==========
-1.6 Series
-==========
+===========
+Passlib 1.6
+===========
**1.6.5** (2015-08-04)
======================
diff --git a/docs/history/1.7.rst b/docs/history/1.7.rst
index ba9b926..a833628 100644
--- a/docs/history/1.7.rst
+++ b/docs/history/1.7.rst
@@ -1,13 +1,8 @@
.. _whats-new:
-==========
-1.7 Series
-==========
-
-.. seealso::
-
- The `Roadmap <https://bitbucket.org/ecollins/passlib/wiki/Roadmap>`_
- for a list of future changes that may impact applications.
+===========
+Passlib 1.7
+===========
.. rst-class:: emphasize-children toc-always-open
diff --git a/docs/history/ancient.rst b/docs/history/ancient.rst
index 797f584..f8a34ed 100644
--- a/docs/history/ancient.rst
+++ b/docs/history/ancient.rst
@@ -1,6 +1,6 @@
-=============
-1.4 & Earlier
-=============
+=====================
+Passlib 1.4 & Earlier
+=====================
**1.4** (2011-05-04)
====================
diff --git a/docs/history/index.rst b/docs/history/index.rst
index c4a6689..219b713 100644
--- a/docs/history/index.rst
+++ b/docs/history/index.rst
@@ -4,19 +4,36 @@
Release History
===============
-.. centered:: This is the documentation for the :ref:`1.7.0 Release <whats-new>` of Passlib.
-
-.. rst-class:: float-right
+.. rst-class:: float-center without-title
.. seealso::
- The `Roadmap <https://bitbucket.org/ecollins/passlib/wiki/Roadmap>`_
- for a list of future changes that may impact applications.
+ **For the latest release:** see :ref:`What's New <whats-new>` in Passlib 1.7
+
+.. toctree::
+ :maxdepth: 2
+
+ 1.7 Series <1.7>
+
+.. toctree::
+ :maxdepth: 2
+
+ 1.6 Series <1.6>
.. toctree::
:maxdepth: 2
- 1.7
- 1.6
- 1.5
- ancient
+ 1.5 Series <1.5>
+
+.. toctree::
+ :maxdepth: 2
+
+ 1.4 & Earlier <ancient>
+
+.. rst-class:: float-center without-title
+
+.. seealso::
+
+ See the `Project Roadmap <https://bitbucket.org/ecollins/passlib/wiki/Roadmap>`_
+ for a list of future changes that may impact applications.
+
diff --git a/docs/index.rst b/docs/index.rst
index d21f9ee..8409ef9 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,7 +2,8 @@
:align: center
:class: show-for-small
-.. rst-class:: float-right without-title
+
+.. rst-class:: float-right
.. seealso:: :ref:`What's new in Passlib 1.7 <whats-new>`
@@ -18,6 +19,14 @@ Passlib |release| documentation
For documentation of the latest stable version,
see `<https://passlib.readthedocs.io>`_.
+.. only:: pypi
+
+ .. warning::
+
+ The official Passlib documentation have moved to `<https://passlib.readthedocs.io>`_.
+ Documentation at this location is still being maintained,
+ but will be updated much less frequently.
+
Welcome
=======
Passlib is a password hashing library for Python 2 & 3, which provides