OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: update genrest script for latest kconfiglib 

The genrest.py script (used to generate config documentation from the
Kconfig files) broke when upgrading to the latest kconfiglib (10.9.1).
Copied the latest genrest.py script from the Zephyr project (where this
script and processing was developed) and things work again.

Update Makefile's call to genrest.py (toplevel Kconfig path is now found
relative to the srctree.

Update requirements.txt to match the kconfiglib version family
verified to work.

fixes: #1387

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>

Documentation scripts: enhance 'show-versions.py'

Modify the doc/scripts/show-versions.py script by making it
gather the list of Python modules to check the version for from
the "requirements.txt" file. It should help keep this in sync
if/when our requirements evolve.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
This commit is contained in:
David B. Kinder 2018-10-01 14:25:21 -07:00 committed by David Kinder
parent 1c0a05705f
commit 8e21d5ee99
3 changed files with 35 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Makefile
View File

@ -46,7 +46,7 @@ content:
kconfig: kconfig:
$(Q)srctree=../hypervisor \ $(Q)srctree=../hypervisor \
python3 scripts/genrest.py ../hypervisor/Kconfig reference/kconfig/ python3 scripts/genrest.py Kconfig reference/kconfig/
pullsource: pullsource:
$(Q)scripts/pullsource.sh $(Q)scripts/pullsource.sh

2
doc/scripts/requirements.txt
View File

@ -2,4 +2,4 @@ breathe==4.9.1
sphinx==1.7.7 sphinx==1.7.7
docutils==0.14 docutils==0.14
sphinx_rtd_theme==0.4.0 sphinx_rtd_theme==0.4.0
kconfiglib==10.9.1 kconfiglib==10.*

43
doc/scripts/show-versions.py
View File

@ -6,15 +6,38 @@
# #
# Show installed versions of doc building tools # Show installed versions of doc building tools
import os.path
import sys
import pkg_resources
import subprocess import subprocess
print ("breathe version: " + class color:
__import__("breathe").__version__ + "\n" + PURPLE = '\033[95m'
"docutils version: " + CYAN = '\033[96m'
__import__("docutils").__version__ + "\n" + DARKCYAN = '\033[36m'
"sphinx version: " + BLUE = '\033[94m'
__import__("sphinx").__version__ + "\n" + GREEN = '\033[92m'
"sphinx_rtd_theme version: " + YELLOW = '\033[93m'
__import__("sphinx_rtd_theme").__version__ + "\n" + RED = '\033[91m'
"doxygen version: " + BOLD = '\033[1m'
subprocess.check_output(["doxygen", "-v"]).decode("utf-8")) UNDERLINE = '\033[4m'
END = '\033[0m'
# Check all requirements listed in requirements.txt and print out version installed (if any)
print ("Listing versions of doc build dependencies found on your system...\n")
rf = open(os.path.join(sys.path[0], "requirements.txt"),"r")
for reqs in pkg_resources.parse_requirements(rf):
try:
ver = pkg_resources.get_distribution(reqs.project_name).version
print (" " + reqs.project_name.ljust(25," ") + " version: " + ver)
except:
print (color.RED + color.BOLD + reqs.project_name + " is missing." + color.END +
" (Hint: install all dependencies with " + color.YELLOW +
"\"pip3 install --user -r requirements.txt\"" + color.END + ")")
rf.close()
# Print out the version of Doxygen (not installed via pip3)
print (" " + "doxygen".ljust(25," ") + " version: " + subprocess.check_output(["doxygen", "-v"]).decode("utf-8"))