From: W. Trevor King <wking@drexel.edu>
Date: Fri, 17 Feb 2012 20:02:57 +0000 (-0500)
Subject: Shuffle doc/conf.py to get the Git revision into the Sphinx documentation.
X-Git-Tag: 1.1.0~165
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=9a56363ccfff67a4d571042c18aae6a0e1b81bfc;p=be.git

Shuffle doc/conf.py to get the Git revision into the Sphinx documentation.
---

diff --git a/doc/conf.py b/doc/conf.py
index 2019127..a115ce4 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -50,17 +50,10 @@ copyright = u'2010, W. Trevor King'
 # built documents.
 #
 # The short X.Y version.
-version = libbe.version.version()
+version = libbe.version.version(3)
 # 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)
+release = '%s (%s)' % (libbe.version.version(),
+                       libbe.version.version_info['revision'])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -118,8 +111,17 @@ html_theme = 'default'
 # "<project> v<release> documentation".
 #html_title = None
 
+# 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, version)
+
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
+html_short_title = '%s %s documentation' % (project, release)
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.