summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2011-01-07 21:28:41 +0000
committerEli Collins <elic@assurancetechnologies.com>2011-01-07 21:28:41 +0000
commit73c49e8b127ff0ec9fc80a7c3a21d610e159578c (patch)
treeb02ee27f9fcbef6aeb56ce27a555dbf23f30edb3 /docs/conf.py
parent77e4c1c4618afbbe2ea0334c7c6b13e0e2d3484e (diff)
downloadpasslib-73c49e8b127ff0ec9fc80a7c3a21d610e159578c.tar.gz
doc building now uses astdoc, updated masthead & logo
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py29
1 files changed, 13 insertions, 16 deletions
diff --git a/docs/conf.py b/docs/conf.py
index edf7e0a..6bf186e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -21,11 +21,10 @@ doc_root = os.path.abspath(os.path.join(__file__,os.path.pardir))
source_root = os.path.abspath(os.path.join(doc_root,os.path.pardir))
sys.path.insert(0, source_root)
-#check for Assurance Technologies' BPS library, to conditionally load in some helpers
-try:
- import bps
-except ImportError:
- bps = None
+#building docs requires Assurance Technologies' AstDoc library
+# http://www.assurancetechnologies.com/software/astdoc
+#which contains some sphinx extensions used by passlib
+import astdoc
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -39,9 +38,10 @@ except ImportError:
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
-## 'bps.unstable.bpsdoc.index_styles',
-## 'bps.unstable.bpsdoc.relbar_toc',
-## 'bps.unstable.bpsdoc.nested_sections',
+
+ 'astdoc.ext.index_styles', #adds extra ids & classes to index html, for additional styling
+ 'astdoc.ext.relbar_toc', #inserts toc into right hand nav bar (ala old style python docs)
+ 'astdoc.ext.nested_sections', #handles ReST markup within function/class docstrings
]
# Add any paths that contain templates here, relative to this directory.
@@ -69,8 +69,7 @@ copyright = u'2008-2010, Assurance Technologies, LLC'
# version: The short X.Y version.
# release: The full version, including alpha/beta/rc tags.
from passlib import __version__ as release
-import re
-version = re.match("(\d+\.\d+)", release).group(1)
+version = astdoc.get_version(release)
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -118,21 +117,19 @@ keep_warnings = True
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
-##html_style = 'bps.css'
+##html_style = 'xxx.css'
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
-##html_theme = 'cloud'
-html_theme = "nature"
+html_theme = 'cloud'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-##html_theme_options = { "roottarget": index_doc }
+html_theme_options = { "roottarget": index_doc }
# Add any paths that contain custom themes here, relative to this directory.
-##from bps.unstable.bpsdoc import theme_path
-##html_theme_path = [theme_path]
+html_theme_path = [astdoc.get_theme_dir()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".