diff options
author | Peter Maydell <peter.maydell@linaro.org> | 2016-11-04 18:35:37 +0000 |
---|---|---|
committer | Peter Maydell <peter.maydell@linaro.org> | 2019-05-21 10:47:22 +0100 |
commit | 104903dade4bdcc6ea829dd7f56c073d5491d800 (patch) | |
tree | 35f75da3c551523344e4c9c98fd99c9421106779 /docs/conf.py | |
parent | 822fe80cec951ef6933a01d5e5240108c85fb3bb (diff) |
docs/conf.py: Enable use of kerneldoc sphinx extension
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/conf.py b/docs/conf.py index befbcc6c3e..9109edbcb9 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, '..') |