almalinux/lorax
13
0
Fork 0
Code Issues Pull Requests Releases Activity

Override Sphinx documentation version with LORAX_VERSION

Browse Source 
Normally you want to document the NEXT release, not the last. This
allows you to build the documentation using:

LORAX_VERSION="29.6" make docs
This commit is contained in:
Brian C. Lane 2018-06-04 16:25:33 -07:00
parent 6f6ce410c0
commit d47d38e0c8
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/conf.py
View File

@ -57,7 +57,11 @@ copyright = u'2018, Red Hat, Inc.' # pylint: disable=redefined-builtin
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
def read_version(): def read_version():
""" Read version from ../lorax.spec""" """Read version from $LORAX_VERSION or ../lorax.spec"""
# This allows the .spec version to be overridded. eg. when documenting an upcoming release
if "LORAX_VERSION" in os.environ:
return os.environ["LORAX_VERSION"]
import re import re
version_re = re.compile(r"Version:\s+(.*)") version_re = re.compile(r"Version:\s+(.*)")
with open("../lorax.spec", "rt") as f: with open("../lorax.spec", "rt") as f: