Skip to content

Commit 287fc4c

Browse files
committed
doc: add hypervisor kconfig option reference
Modify the Zephyr project script for creating documentation from Kconfig files to generate the hypervisor option configuration docs. While Zephyr uses a modified version of kconfiglib, we can use the standard kconfiglib from Pypi (added to the requirements.txt file). Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1 parent 37f33fd commit 287fc4c

File tree

6 files changed

+395
-2
lines changed

6 files changed

+395
-2
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ devicemodel/include/version.h
66
doc/doxygen
77
doc/_build
88
doc/tools
9+
doc/reference/kconfig/*.rst
910
build
1011
*.bak
1112
*.sav
1213
*.log
1314
*.warnings
15+
*.pyc

doc/Makefile

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,15 @@ SPHINXPROJ = "Project ACRN"
1414
SOURCEDIR = .
1515
BUILDDIR ?= _build
1616

17+
# document publication assumes the folder structure is setup
18+
# with the acrn-hypervisor and projectacrn.github.io repos as
19+
# sibling folders and make is run inside the acrn-hypervisor/docs
20+
# folder.
21+
22+
ACRN_BASE = "$(CURDIR)/../.."
1723
DOC_TAG ?= development
1824
RELEASE ?= latest
19-
PUBLISHDIR = ../../projectacrn.github.io/$(RELEASE)
25+
PUBLISHDIR = $(ACRN_BASE)/projectacrn.github.io/$(RELEASE)
2026

2127
# Put it first so that "make" without argument is like "make help".
2228
help:
@@ -38,7 +44,11 @@ doxy:
3844
content:
3945
$(Q)scripts/extract_content.py
4046

41-
html: doxy content
47+
kconfig:
48+
$(Q)srctree=../hypervisor \
49+
python3 scripts/genrest.py ../hypervisor/Kconfig reference/kconfig/
50+
51+
html: doxy content kconfig
4252
-$(Q)$(SPHINXBUILD) -t $(DOC_TAG) -b html -d $(BUILDDIR)/doctrees $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(OPTS) >> doc.log 2>&1
4353
$(Q)./scripts/filter-doc-log.sh doc.log
4454

@@ -48,6 +58,7 @@ html: doxy content
4858
clean:
4959
rm -fr $(BUILDDIR) doxygen
5060
rm -fr tools
61+
rm -fr reference/kconfig/*.rst
5162

5263
# Copy material over to the GitHub pages staging repo
5364
# along with a README

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Sections
3232
howtos/index.rst
3333
release_notes.rst
3434
contribute/index.rst
35+
reference/kconfig/index.rst
3536
api/index.rst
3637
tools.rst
3738

doc/reference/kconfig/readme.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This directory has auto-generated files, do not edit any of the files here.

0 commit comments

Comments
 (0)