github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-07-31 07:20:55 +00:00
Code Issues Projects Releases Wiki Activity

doc: allow overriding displayed doc version

Browse Source 
In special cases, we'd like to freeze doc versions based on a tag (e.g.,
tags/acrn-2018w34.4-140000p) and have that version show up on the
generated docs.  (Normally the version shown is from the
hypervisor/VERSION file.)

With this patch, if DOC_TAG=release then it uses a RELEASE=name
environment variable (e.g., from the make command line) to override the
displayed version:

    make DOC_TAG=release RELEASE=acrn-2018w34.4-140000p html
    make DOC_TAG=release RELEASE=acrn-2018w34.4-140000p publish

Assuming you've checked out the tagged branch (both for acrn-hypervisor
and acrn-kernel), these make commands will generate and publish docs to
https://projectacrn.github.io/acrn-2018w34.4-14000p

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2018-09-11 16:18:01 -07:00 committed by David Kinder
parent dbcbe7d1ff
commit 42d9b24a54
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/conf.py
View File

@ -20,6 +20,9 @@ import os
import sys
sys.path.insert(0, os.path.abspath('.'))
RELEASE = ""
if "RELEASE" in os.environ:
RELEASE = os.environ["RELEASE"]
# -- General configuration ------------------------------------------------
@ -177,6 +180,8 @@ else:
if tags.has('release'):
current_version = version
if RELEASE:
version = current_version = RELEASE
else:
version = current_version = "latest"