[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 3/8] docs/conf.py: Enable use of kerneldoc sphinx extension
From: |
Paolo Bonzini |
Subject: |
[PATCH 3/8] docs/conf.py: Enable use of kerneldoc sphinx extension |
Date: |
Fri, 29 Nov 2019 15:02:12 +0100 |
From: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
---
docs/conf.py | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
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, '..')
--
2.21.0
- [PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build, Paolo Bonzini, 2019/11/29
- [PATCH 2/8] docs: tweak kernel-doc for QEMU coding standards, Paolo Bonzini, 2019/11/29
- [PATCH 3/8] docs/conf.py: Enable use of kerneldoc sphinx extension,
Paolo Bonzini <=
- [PATCH 7/8] memory.h: Silence kernel-doc complaints, Paolo Bonzini, 2019/11/29
- [PATCH 4/8] Makefile: disable Sphinx nitpicking, Paolo Bonzini, 2019/11/29
- [PATCH 6/8] docs: Create bitops.rst as example of kernel-docs, Paolo Bonzini, 2019/11/29
- [PATCH 5/8] bitops.h: Silence kernel-doc complaints, Paolo Bonzini, 2019/11/29
- [PATCH 8/8] docs: add memory API reference, Paolo Bonzini, 2019/11/29
- [PATCH 1/8] docs: import Linux kernel-doc script and extension, Paolo Bonzini, 2019/11/29
- Re: [PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build, no-reply, 2019/11/29