[3/8] docs/conf.py: Enable use of kerneldoc sphinx extension

Message ID 20191129140217.17797-4-pbonzini@redhat.com
State Superseded
Headers show
Series
  • Untitled series #25313
Related show

Commit Message

Paolo Bonzini Nov. 29, 2019, 2:02 p.m.
From: Peter Maydell <peter.maydell@linaro.org>


Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Message-Id: <20190521122519.12573-4-peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>

---
 docs/conf.py | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

-- 
2.21.0

Patch

diff --git a/docs/conf.py b/docs/conf.py
index b7edb0666b..259c6049da 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -54,7 +54,7 @@  needs_sphinx = '1.3'
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['qmp_lexer']
+extensions = ['kerneldoc', 'qmp_lexer']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -216,3 +216,8 @@  texinfo_documents = [
 
 
 
+# We use paths starting from qemu_docdir here so that you can run
+# sphinx-build from anywhere and the kerneldoc extension can still
+# find everything.
+kerneldoc_bin = os.path.join(qemu_docdir, '../scripts/kernel-doc')
+kerneldoc_srctree = os.path.join(qemu_docdir, '..')