summary refs log tree commit diff stats
path: root/docs/devel/conf.py
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2019-03-07 15:21:54 +0000
committerPeter Maydell <peter.maydell@linaro.org>2019-03-07 15:21:54 +0000
commit21afe115a49776aa07f4d93d22b9ad133fd183a5 (patch)
tree06c13402442f44873748d983cf1d56b28bcac405 /docs/devel/conf.py
parent3a75ef6a0fe397b0d36930415be6b123750a6afe (diff)
parentc10e01b996df09f6cb4eceb2b7a9754bece927c9 (diff)
downloadfocaccia-qemu-21afe115a49776aa07f4d93d22b9ad133fd183a5.tar.gz
focaccia-qemu-21afe115a49776aa07f4d93d22b9ad133fd183a5.zip
Merge remote-tracking branch 'remotes/pmaydell/tags/pull-sphinx-20190307' into staging
Enable building and installing rST docs with Sphinx

# gpg: Signature made Thu 07 Mar 2019 15:05:12 GMT
# gpg:                using RSA key E1A5C593CD419DE28E8315CF3C2525ED14360CDE
# gpg:                issuer "peter.maydell@linaro.org"
# gpg: Good signature from "Peter Maydell <peter.maydell@linaro.org>" [ultimate]
# gpg:                 aka "Peter Maydell <pmaydell@gmail.com>" [ultimate]
# gpg:                 aka "Peter Maydell <pmaydell@chiark.greenend.org.uk>" [ultimate]
# Primary key fingerprint: E1A5 C593 CD41 9DE2 8E83  15CF 3C25 25ED 1436 0CDE

* remotes/pmaydell/tags/pull-sphinx-20190307:
  MAINTAINERS: Add entry for Sphinx documentation infrastructure
  docs/conf.py: Don't hard-code QEMU version
  Makefile: Abstract out "identify the pkgversion" code
  Makefile, configure: Support building rST documentation
  docs: Provide separate conf.py for each manual we want
  docs/conf.py: Disable option warnings
  docs/conf.py: Don't include rST sources in HTML build
  docs/conf.py: Configure the 'alabaster' theme
  docs/conf.py: Disable unused _static directory
  docs: Commit initial files from sphinx-quickstart
  docs: Convert memory.txt to rst format
  docs/cpu-hotplug.rst: Fix rST markup issues

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Diffstat (limited to 'docs/devel/conf.py')
-rw-r--r--docs/devel/conf.py15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/devel/conf.py b/docs/devel/conf.py
new file mode 100644
index 0000000000..7441f87e7f
--- /dev/null
+++ b/docs/devel/conf.py
@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+#
+# QEMU documentation build configuration file for the 'devel' manual.
+#
+# This includes the top level conf file and then makes any necessary tweaks.
+import sys
+import os
+
+qemu_docdir = os.path.abspath("..")
+parent_config = os.path.join(qemu_docdir, "conf.py")
+exec(compile(open(parent_config, "rb").read(), parent_config, 'exec'))
+
+# This slightly misuses the 'description', but is the best way to get
+# the manual title to appear in the sidebar.
+html_theme_options['description'] = u'Developer''s Guide'