diff options
| author | W. Trevor King <wking@drexel.edu> | 2012-02-17 15:02:57 -0500 |
|---|---|---|
| committer | W. Trevor King <wking@drexel.edu> | 2012-02-17 15:02:57 -0500 |
| commit | 9a56363ccfff67a4d571042c18aae6a0e1b81bfc (patch) | |
| tree | 9e637afe638cd7a9857524791bac33259e28c9c7 /doc | |
| parent | 940470a5469c24ad3e724621d8c92ee9cc44e6bf (diff) | |
| download | bugseverywhere-9a56363ccfff67a4d571042c18aae6a0e1b81bfc.tar.gz | |
Shuffle doc/conf.py to get the Git revision into the Sphinx documentation.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/conf.py | 22 |
1 files changed, 12 insertions, 10 deletions
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. |