diff options
| author | W. Trevor King <wking@drexel.edu> | 2010-10-22 14:49:59 -0400 |
|---|---|---|
| committer | W. Trevor King <wking@drexel.edu> | 2010-10-22 14:49:59 -0400 |
| commit | 9d8ca3e2b8b5231cef8b21101d44b8bb06f4d177 (patch) | |
| tree | 5edbd8d6e45b875d2e64aedcb543351aca670c18 | |
| parent | c07c687273afc1f38258d3fa5caf39244c0d1b33 (diff) | |
| download | bugseverywhere-9d8ca3e2b8b5231cef8b21101d44b8bb06f4d177.tar.gz | |
'be vXXX' -> 'be XXX' in Sphinx-generated docs to avoid git-hash confusion.
| -rw-r--r-- | doc/conf.py | 8 |
1 files changed, 8 insertions, 0 deletions
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 |