[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH 03/11] docs: Commit initial files from sphinx-qu
From: |
Alex Bennée |
Subject: |
Re: [Qemu-devel] [PATCH 03/11] docs: Commit initial files from sphinx-quickstart |
Date: |
Fri, 01 Feb 2019 16:41:20 +0000 |
User-agent: |
mu4e 1.0; emacs 26.1 |
Peter Maydell <address@hidden> writes:
> Commit the initial Sphinx conf.py and skeleton index.rst as
> generated with sphinx-quickstart
> ---
> 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
>
> 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'
Hmm I bet we forget to update this date. Does it have to be the date the
text was last touched or could we just go from the last commit in the tree?
> +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'
Surely these need to come from the build system the same way the
build-id does?
Otherwise:
Reviewed-by: Alex Bennée <address@hidden>
--
Alex Bennée
- [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 01/11] docs/cpu-hotplug.rst: Fix rST markup issues, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 04/11] docs/conf.py: Disable unused _static directory, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 03/11] docs: Commit initial files from sphinx-quickstart, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 06/11] docs/conf.py: Don't include rST sources in HTML build, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 07/11] docs/conf.py: Disable option warnings, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 05/11] docs/conf.py: Configure the 'alabaster' theme, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 02/11] docs: Convert memory.txt to rst format, Peter Maydell, 2019/02/01