From: W. Trevor King <wking@drexel.edu>
Date: Fri, 22 Oct 2010 18:49:59 +0000 (-0400)
Subject: 'be vXXX' -> 'be XXX' in Sphinx-generated docs to avoid git-hash confusion.
X-Git-Tag: 1.0.0~3^2~8
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=9d8ca3e2b8b5231cef8b21101d44b8bb06f4d177;p=be.git

'be vXXX' -> 'be XXX' in Sphinx-generated docs to avoid git-hash confusion.
---

diff --git a/doc/conf.py b/doc/conf.py
index 371480e..2019127 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -54,6 +54,14 @@ version = libbe.version.version()
 # The full version, including alpha/beta/rc tags.
 release = libbe.version.version()
 
+# Override default sphinx.config.Config.configvalues[html_title] to
+# change formatting string from '%s v%s' to '%s %s'.  With git-commit
+# versions, the original formatting string gives titles like
+#   bugs-everywhere vc07c687273afc1f38258d3fa5caf39244c0d1b33
+# which may suprise users who don't realize the leading 'v' is not
+# part of the hash.
+html_title = '%s %s documentation' % (project, release)
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None