Commit c10482ae authored by Jeremy Newton's avatar Jeremy Newton Committed by Tim Writer
Browse files

Allow specifying driver release/version in doc makefile 

Signed-off-by: default avatarJeremy Newton <Jeremy.Newton@amd.com>
Reviewed-by: default avatarSlava Abramov <slava.abramov@amd.com>
parent 1877a984

Makefile

+5 −1
Changes for Makefile: 5 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -6,6 +6,10 @@ SPHINXOPTS = 
SPHINXBUILD   = sphinx-build

PAPER         =

BUILDDIR      = build

#VERSION represents the driver version

VERSION       = unknown

#RELEASE is the driver version and build number

RELEASE       = unknown-build



# User-friendly check for sphinx-build

ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -15,7 +19,7 @@ endif 
# Internal variables.

PAPEROPT_a4     = -D latex_paper_size=a4

PAPEROPT_letter = -D latex_paper_size=letter

ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source

ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) -D version=$(VERSION) -D release=$(RELEASE) source

# the i18n builder cannot share the environment and doctrees with the others

I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source

source/conf.py

+3 −2
Changes for source/conf.py: 3 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -55,9 +55,10 @@ author = u'Advanced Micro Devices, Inc.' 
# built documents.

#

# The short X.Y version.

version = u'release'

version = u'unknown'

# The full version, including alpha/beta/rc tags.

release = u'18.30'

release = u'unknown-build'

# Note: version and release is overwritten by the Makefile



# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.