summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2011-03-25 20:35:05 -0400
committerEli Collins <elic@assurancetechnologies.com>2011-03-25 20:35:05 -0400
commit56327c7d2127d1cd5e1682772fd52c13c256d4ec (patch)
tree920168be74838ddeff3e4d5af38c1860e45976c0 /docs
parenteea350011c457b98d1044b6a9873d995b276cf35 (diff)
downloadpasslib-56327c7d2127d1cd5e1682772fd52c13c256d4ec.tar.gz
renamed 'astdoc' sphinx theme imports to 'cloud_sptheme'; other small doc fixes
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py16
-rw-r--r--docs/lib/passlib.hosts.rst2
2 files changed, 9 insertions, 9 deletions
diff --git a/docs/conf.py b/docs/conf.py
index adfa516..171c229 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -25,10 +25,10 @@ sys.path.insert(0, source_root)
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
-#building the docs requires Assurance Technologies' AstDoc library
-# https://bitbucket.org/ecollins/astdoc
+#building the docs requires the Cloud sphinx theme & extensions
+# https://bitbucket.org/ecollins/cloud_sptheme
#which contains some sphinx extensions used by passlib
-import astdoc
+import cloud_sptheme
# -- General configuration -----------------------------------------------------
@@ -42,9 +42,9 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
- 'astdoc.ext.autodoc_sections', #add autdoc support for ReST sections in class/function docstrings
- 'astdoc.ext.index_styling', #adds extra ids & classes to genindex html, for additional styling
- 'astdoc.ext.relbar_toc', #inserts toc into right hand nav bar (ala old style python docs)
+ 'cloud_sptheme.ext.autodoc_sections', #add autdoc support for ReST sections in class/function docstrings
+ 'cloud_sptheme.ext.index_styling', #adds extra ids & classes to genindex html, for additional styling
+ 'cloud_sptheme.ext.relbar_toc', #inserts toc into right hand nav bar (ala old style python docs)
]
# Add any paths that contain templates here, relative to this directory.
@@ -72,7 +72,7 @@ copyright = u'2008-2011, Assurance Technologies, LLC'
# version: The short X.Y version.
# release: The full version, including alpha/beta/rc tags.
from passlib import __version__ as release
-version = astdoc.get_version(release)
+version = cloud_sptheme.get_version(release)
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -127,7 +127,7 @@ else:
html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [astdoc.get_theme_dir()]
+html_theme_path = [cloud_sptheme.get_theme_dir()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
diff --git a/docs/lib/passlib.hosts.rst b/docs/lib/passlib.hosts.rst
index e702ebe..a47f799 100644
--- a/docs/lib/passlib.hosts.rst
+++ b/docs/lib/passlib.hosts.rst
@@ -67,7 +67,7 @@ Scheme Linux FreeBSD NetBSD OpenBSD
All of the above contexts will also recognize password hashes
of the form ``!`` or ``*`` as belonging to a special
- :class:`unix_fallback` handler, whose ``verify()`` method
+ :class:`~passlib.hash.unix_fallback` handler, whose ``verify()`` method
will return ``False`` for these strings, treating them as disabled.
This same handler will also recognize an empty string as being a wildcard password.