From patchwork Tue Mar 5 17:21:30 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 159701 Delivered-To: patch@linaro.org Received: by 2002:a02:5cc1:0:0:0:0:0 with SMTP id w62csp5224360jad; Tue, 5 Mar 2019 09:28:12 -0800 (PST) X-Google-Smtp-Source: APXvYqybiLBxZpnD3edDmZzZTmHQ2rt6iiCGcfnGh933+e6RuCrx6w97fRBVJjeYwBmfq+JODI7Z X-Received: by 2002:a25:8149:: with SMTP id j9mr3276607ybm.400.1551806892002; Tue, 05 Mar 2019 09:28:12 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1551806891; cv=none; d=google.com; s=arc-20160816; b=mCTj4CK9wC9F+YsvHarN54K01TnbTomgGRHrojFYvpAKTeyO36TYVCVfPAiSVmslHs LGafP+Rl25FeuyTGXcDQZQfjfgkIGl37BHDJnTi9IkKldFFIPp0C46kYDbx3MxwvvPyz mH/g0D+JOxnprfhprcwyDNGnNurTV6LzlPNJK151SsD9HAGPvtOKfxGWsg84KH83GUe5 NrVGkBHo5JRebbGLwDz1k41QIdFTQFDcyFgq724AvudwG8Mp7Sho9wIVy6M8k4+g8URC d117Ub3xK0XTkDYuvMJtAn6UYejXDwxcozS3BLztF8UgKK0yfMwDSoCtARsRBnwsLgSZ 3ATQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=Hcmr58/vFQKeFxBv45zNtbUyT6GOSIfsDz+3Rdf8Xck=; b=oiR2lPyHK7qHHoTU1rumsGiUAFVwjPPZUXFqTGUxtjoR956PxqCDz8jfnwsujFnwsj w1Si4WT4fzTByNzHuHkG2q4pI+EqdNKTUu0wqhFZ71pNwj/BHK0Ju109Je9kDBdZVNoT MbIAOJob5B1jFqe1sQ9zXHfkyWNHwWzf3YnKgwBaCT12ZVxCO/D8zQfkOCpiWlyniTtG Ybn4Zh7tPHUFF9jPCZuxtUTsDuCLASjQfMIYNuShC7p2Ywo8Et/HiWd7Ih9ygT8fWiEr jqLnqVS3k1nvdeqDB+ccCASMIUW3+cAhen7xJ85eVq1hkef5riQILmDl6n6Qy5MzI4hB 0lqQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=p3THOfPn; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id w129si5857323ybg.411.2019.03.05.09.28.11 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 05 Mar 2019 09:28:11 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=p3THOfPn; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:46532 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DrP-0006dD-FT for patch@linaro.org; Tue, 05 Mar 2019 12:28:11 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35504) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlF-00029F-6T for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:50 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlD-0000bj-TK for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:49 -0500 Received: from mail-wr1-x441.google.com ([2a00:1450:4864:20::441]:36619) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlD-0000YU-MJ for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:47 -0500 Received: by mail-wr1-x441.google.com with SMTP id o17so10377685wrw.3 for ; Tue, 05 Mar 2019 09:21:47 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Hcmr58/vFQKeFxBv45zNtbUyT6GOSIfsDz+3Rdf8Xck=; b=p3THOfPn1xbP/8kcFkRWESr9XIei0FdEJsZANBYeSotzfM0wiebSCUG5zQrCG9N6wU SHfAE6jJiRu8vZMzIMXrU1e5D9veBQNGmrvoQeLSDDLW1vUkDbg9WG7F9oTCnDIaoG2w EQ+8xU+HkZ33Jf92BPg6qNc8TM0IzSLNvWrXxvYd2sjdvkKl78/wQmAv7xuEjxIGRqOW lkb11sFZWc+jMdw+3WdAC9/dYvMLSE1SZDxNlDF/t9QDRaalCRRo6ij/khDDr8Ys4qht tbtgZ9hbrE+OiJMAUkftMz+EezSnX+OwKs7XrVnyFqcrMdU5VIBVxCJNSmCZESnm+q1Q pEWA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Hcmr58/vFQKeFxBv45zNtbUyT6GOSIfsDz+3Rdf8Xck=; b=Ms1L9kxM4N/BYM7KEgU7h5d+Zz+MW5CGbYsefEvufrzOiK2md2FV7PmWfHTnfWnKRM W5PWGOlRE6u4i5UHBCV0XhJaZJbT3p2lxlwlBtU5BLs436EN9PvdxVwrLlDpu1YoFIYs QEwYenn8LGxksCPEPT1XUxgg4AZ+hobPLAaLO5kxGG78+m3BdT7DQxxKzWeS/2vY/5PA UUaonp6ppsiDOPp62kd24lcbaEOeLwqlXlZdgKUzshMEmJ6Fqhgp6lCAqqomevMjxqs/ QHew/ebmLC6W5tzllApQxFQ8BN2y1hV02Gio8mhdqWb9/V0y/fZ7u6B7LTNQdd1ZpfYQ 4ptA== X-Gm-Message-State: APjAAAV5OSJsWk9JEwN0A87AcQeTsl6eMtFrhYAh1wbE7RAxvQUojgKe +yVmNdaUN7Q1GpNlK6tJo42ANdQC1C4= X-Received: by 2002:adf:fd46:: with SMTP id h6mr16781547wrs.170.1551806506205; Tue, 05 Mar 2019 09:21:46 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.44 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:45 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:30 +0000 Message-Id: <20190305172139.32662-4-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-1-peter.maydell@linaro.org> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::441 Subject: [Qemu-devel] [PATCH v3 03/12] docs: Commit initial files from sphinx-quickstart X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" Commit the initial Sphinx conf.py and skeleton index.rst as generated with sphinx-quickstart. We'll update these to add QEMU-specific tweaks in subsequent commits. Signed-off-by: Peter Maydell Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-4-peter.maydell@linaro.org --- docs/conf.py | 168 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 20 ++++++ 2 files changed, 188 insertions(+) create mode 100644 docs/conf.py create mode 100644 docs/index.rst -- 2.20.1 Acked-by: Richard Henderson diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000000..53a17506615 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,168 @@ +# -*- coding: utf-8 -*- +# +# QEMU documentation build configuration file, created by +# sphinx-quickstart on Thu Jan 31 16:40:14 2019. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'QEMU' +copyright = u'2019, The QEMU Project Developers' +author = u'The QEMU Project Developers' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'4.0' +# The full version, including alpha/beta/rc tags. +release = u'4.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'QEMUdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'QEMU.tex', u'QEMU Documentation', + u'The QEMU Project Developers', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'qemu', u'QEMU Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'QEMU', u'QEMU Documentation', + author, 'QEMU', 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000000..93f82228310 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. QEMU documentation master file, created by + sphinx-quickstart on Thu Jan 31 16:40:14 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to QEMU's documentation! +================================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`