From 5c6bfd7392accf8ac117ad55be682790eadda5e5 Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Fri, 16 Mar 2018 10:18:42 -0700 Subject: [PATCH] doc: improvements for sphinx generation Handle version retrieval better when comments are present. Add warning if Sphinx theme (read_the_docs) is missing. Signed-off-by: David B. Kinder --- conf.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/conf.py b/conf.py index 9ee55d031..576279f56 100644 --- a/conf.py +++ b/conf.py @@ -57,13 +57,17 @@ author = u'Project ARCN developers' # Makefile from the acrn-hypervisor repo by finding these lines: # MAJOR_VERSION=0 # MINOR_VERSION=1 +# RC_VERSION=1 try: version_major = None version_minor = None version_rc = None for line in open(os.path.normpath("../acrn-hypervisor/Makefile")) : - if line.count("=") : + # remove comments + line = line.split('#', 1)[0] + line = line.rstrip() + if (line.count("=") == 1) : key, val = [x.strip() for x in line.split('=', 2)] if key == 'MAJOR_VERSION': version_major = val @@ -124,6 +128,7 @@ except ImportError: 'searchbox.html', ] } + sys.stderr.write('Warning: sphinx_rtd_theme missing. Use pip to install it.\n') else: html_theme = "sphinx_rtd_theme" html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]