From 3142525fdeed11fa4dfa161d6ef943113214aafb Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Sun, 10 Jun 2018 22:46:03 -0400 Subject: [PATCH] Set docs version from git Removes the need to modify conf.py every time we release. Change-Id: I010c5a4eaf2f2c88156db561218919aa470eaea0 Signed-off-by: Thanh Ha --- docs/conf.py | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index d5decd53..b007a9e9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,10 +18,24 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. # import os +import subprocess import sys import sphinx_bootstrap_theme + sys.path.insert(0, os.path.abspath('..')) + +def format_version(version): + fmt = '{tag}.dev{commitcount}+{gitsha}' + parts = version.split('-') + assert len(parts) in (3, 4) + dirty = len(parts) == 4 + tag, count, sha = parts[:3] + if count == '0' and not dirty: + return tag + return fmt.format(tag=tag, commitcount=count, gitsha=sha.lstrip('g')) + + # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -67,7 +81,13 @@ author = 'Linux Foundation Releng' # built documents. # # The short X.Y version. -version = '0.21.0-dev' +command = 'git describe --tags --long --dirty' +try: + git_version = format_version( + subprocess.check_output(command.split()).decode('utf-8').strip()) +except subprocess.CalledProcessError: # Handle docs builds from tarball + git_version = "v0.0.9999-local" +version = git_version # The full version, including alpha/beta/rc tags. release = version -- 2.16.6