[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [RFC 03/10] docs/conf.py: Enable use of kerneldoc sphinx ex
From: |
Peter Maydell |
Subject: |
[Qemu-devel] [RFC 03/10] docs/conf.py: Enable use of kerneldoc sphinx extension |
Date: |
Tue, 21 May 2019 13:25:12 +0100 |
Signed-off-by: Peter Maydell <address@hidden>
---
docs/conf.py | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index befbcc6c3e1..9109edbcb97 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -41,8 +41,7 @@ except NameError:
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use an absolute path starting from qemu_docdir.
#
-# sys.path.insert(0, os.path.join(qemu_docdir, "my_subdir"))
-
+sys.path.insert(0, os.path.join(qemu_docdir, "sphinx"))
# -- General configuration ------------------------------------------------
@@ -54,7 +53,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 = []
+extensions = ['kerneldoc']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -213,4 +212,10 @@ texinfo_documents = [
]
+# -- Options for configuring kerneldoc extension -------------------------
+# 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.20.1
- [Qemu-devel] [RFC 00/10] Add kernel-doc support to our Sphinx setup, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 03/10] docs/conf.py: Enable use of kerneldoc sphinx extension,
Peter Maydell <=
- [Qemu-devel] [RFC 04/10] docs/conf.py: Ignore some missing references in nitpick mode, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 05/10] bitops.h: Silence kernel-doc complaints, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 02/10] docs: Add kerneldoc sphinx module from Linux, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 10/10] Makefile: disable Sphinx nitpicking, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 07/10] memory.h: Fix kerneldoc syntax issues, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 08/10] docs: Add kernel-doc API documentation to memory.rst, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 09/10] memory.h: attempted kernel-doc fixes, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 06/10] docs: Create bitops.rst as example of kernel-docs, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 01/10] scripts/kernel-doc: Import kernel-doc script from Linux, Peter Maydell, 2019/05/21
- Re: [Qemu-devel] [RFC 00/10] Add kernel-doc support to our Sphinx setup, Peter Maydell, 2019/05/21