'be vXXX' -> 'be XXX' in Sphinx-generated docs to avoid git-hash confusion.
authorW. Trevor King <wking@drexel.edu>
Fri, 22 Oct 2010 18:49:59 +0000 (14:49 -0400)
committerW. Trevor King <wking@drexel.edu>
Fri, 22 Oct 2010 18:49:59 +0000 (14:49 -0400)
doc/conf.py

index 371480eafaa25793a601e24737e2803fe7660be3..201912710fbd480e9b61ab10ffd1d459caabc5b0 100644 (file)
@@ -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