diff mbox series

[03/11] docs: Commit initial files from sphinx-quickstart

Message ID 20190201145035.22739-4-peter.maydell@linaro.org
State Superseded
Headers show
Series Enable build and install of our rST docs | expand

Commit Message

Peter Maydell Feb. 1, 2019, 2:50 p.m. UTC
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

-- 
2.20.1

Comments

Alex Bennée Feb. 1, 2019, 4:41 p.m. UTC | #1
Peter Maydell <peter.maydell@linaro.org> 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 <alex.bennee@linaro.org>



--
Alex Bennée
Peter Maydell Feb. 1, 2019, 4:46 p.m. UTC | #2
On Fri, 1 Feb 2019 at 16:41, Alex Bennée <alex.bennee@linaro.org> wrote:
>

>

> Peter Maydell <peter.maydell@linaro.org> writes:


> > +# 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?


Yeah, this isn't ideal, but the same applies to the
string in QEMU_COPYRIGHT in qemu-common.h (as you can tell
from the fact that still says 2018!). If we can fix that
to be generated from something else we can fish it out when
we do the docs build too.

> > +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?


Yes, see later patch in the series. The idea with the patchset
structure here was that this patch is basically just the
autogenerated stuff (sphinx-quickstart asks a few simple questions
like project name and author which fills these in), and then
the following patches customize that. That seemed to me like
it would be easier to review than if I just squashed everything
into a single patch.

thanks
-- PMM
Peter Maydell Feb. 1, 2019, 5:34 p.m. UTC | #3
On Fri, 1 Feb 2019 at 14:50, Peter Maydell <peter.maydell@linaro.org> wrote:
>

> Commit the initial Sphinx conf.py and skeleton index.rst as

> generated with sphinx-quickstart


Oops, patchew points out that I forgot

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>


thanks
-- PMM
diff mbox series

Patch

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`