Merge branch 'sphinx-for-docs-next' into doc/4.8

output

PS_METHOD	= $(prefer-db2x)

###

# The targets that may be used.

PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs

targets += $(DOCBOOKS)

BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))

xmldocs: $(BOOKS)

		sort -k 2 -k 1 | uniq -f 1 | sed -e 's: :/:' | \

		xargs install -m 644 -t /usr/local/man/man9/

# no-op for the DocBook toolchain

epubdocs:

###

#External programs used

KERNELDOCXMLREF = $(srctree)/scripts/kernel-doc-xml-ref

# -*- makefile -*-

# Makefile for Sphinx documentation

#

# You can set these variables from the command line.

SPHINXBUILD   = sphinx-build

SPHINXOPTS    =

PAPER         =

BUILDDIR      = $(obj)/output

# User-friendly check for sphinx-build

HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi)

ifeq ($(HAVE_SPHINX),0)

.DEFAULT:

	$(warning The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed and in PATH, or set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable.)

	@echo "  SKIP    Sphinx $@ target."

else # HAVE_SPHINX

# User-friendly check for rst2pdf

HAVE_RST2PDF := $(shell if python -c "import rst2pdf" >/dev/null 2>&1; then echo 1; else echo 0; fi)

# Internal variables.

PAPEROPT_a4     = -D latex_paper_size=a4

PAPEROPT_letter = -D latex_paper_size=letter

KERNELDOC       = $(srctree)/scripts/kernel-doc

KERNELDOC_CONF  = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)

ALLSPHINXOPTS   = -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) -d $(BUILDDIR)/.doctrees $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) -c $(srctree)/$(src) $(SPHINXOPTS) $(srctree)/$(src)

# the i18n builder cannot share the environment and doctrees with the others

I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

quiet_cmd_sphinx = SPHINX  $@

      cmd_sphinx = $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2

htmldocs:

	$(call cmd,sphinx,html)

pdfdocs:

ifeq ($(HAVE_RST2PDF),0)

	$(warning The Python 'rst2pdf' module was not found. Make sure you have the module installed to produce PDF output.)

	@echo "  SKIP    Sphinx $@ target."

else # HAVE_RST2PDF

	$(call cmd,sphinx,pdf)

endif # HAVE_RST2PDF

epubdocs:

	$(call cmd,sphinx,epub)

xmldocs:

	$(call cmd,sphinx,xml)

# no-ops for the Sphinx toolchain

sgmldocs:

psdocs:

mandocs:

installmandocs:

cleandocs:

	$(Q)rm -rf $(BUILDDIR)

endif # HAVE_SPHINX

# -*- coding: utf-8 -*-

#

# The Linux Kernel documentation build configuration file, created by

# sphinx-quickstart on Fri Feb 12 13:51:46 2016.

#

# 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.

import sys

import os

# 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.

sys.path.insert(0, os.path.abspath('sphinx'))

# -- 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 = ['kernel-doc']

# Gracefully handle missing rst2pdf.

try:

    import rst2pdf

    extensions += ['rst2pdf.pdfbuilder']

except ImportError:

    pass

# 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 encoding of source files.

#source_encoding = 'utf-8-sig'

# The master toctree document.

master_doc = 'index'

# General information about the project.

project = 'The Linux Kernel'

copyright = '2016, The kernel development community'

author = 'The kernel development community'

# 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.

#

# In a normal build, version and release are are set to KERNELVERSION and

# KERNELRELEASE, respectively, from the Makefile via Sphinx command line

# arguments.

#

# The following code tries to extract the information by reading the Makefile,

# when Sphinx is run directly (e.g. by Read the Docs).

try:

    makefile_version = None

    makefile_patchlevel = None

    for line in open('../Makefile'):

        key, val = [x.strip() for x in line.split('=', 2)]

        if key == 'VERSION':

            makefile_version = val

        elif key == 'PATCHLEVEL':

            makefile_patchlevel = val

        if makefile_version and makefile_patchlevel:

            break

except:

    pass

finally:

    if makefile_version and makefile_patchlevel:

        version = release = makefile_version + '.' + makefile_patchlevel

    else:

        sys.stderr.write('Warning: Could not extract kernel version\n')

        version = release = "unknown version"

# 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

# There are two options for replacing |today|: either, you set today to some

# non-false value, then it is used:

#today = ''

# Else, today_fmt is used as the format for a strftime call.

#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

exclude_patterns = ['output']

# The reST default role (used for this markup: `text`) to use for all

# documents.

#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.

#add_function_parentheses = True

# If true, the current module name will be prepended to all description

# unit titles (such as .. function::).

#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the

# output. They are ignored by default.

#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.

pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.

#modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.

#keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.

todo_include_todos = False

primary_domain = 'C'

highlight_language = 'C'

# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for

# a list of builtin themes.

# The Read the Docs theme is available from

# - https://github.com/snide/sphinx_rtd_theme

# - https://pypi.python.org/pypi/sphinx_rtd_theme

# - python-sphinx-rtd-theme package (on Debian)

try:

    import sphinx_rtd_theme

    html_theme = 'sphinx_rtd_theme'

    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

except ImportError:

    sys.stderr.write('Warning: The Sphinx \'sphinx_rtd_theme\' HTML theme was not found. Make sure you have the theme installed to produce pretty HTML output. Falling back to the default theme.\n')

# 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 themes here, relative to this directory.

#html_theme_path = []

# The name for this set of Sphinx documents.  If None, it defaults to

# "<project> v<release> documentation".

#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.

#html_short_title = None

# The name of an image file (relative to this directory) to place at the top

# of the sidebar.

#html_logo = None

# The name of an image file (within the static path) to use as favicon of the

# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32

# pixels large.

#html_favicon = None

# 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']

# Add any extra paths that contain custom files (such as robots.txt or

# .htaccess) here, relative to this directory. These files are copied

# directly to the root of the documentation.

#html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

# using the given strftime format.

#html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to

# typographically correct entities.

#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.

#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to

# template names.

#html_additional_pages = {}

# If false, no module index is generated.

#html_domain_indices = True

# If false, no index is generated.

#html_use_index = True

# If true, the index is split into individual pages for each letter.

#html_split_index = False

# If true, links to the reST sources are added to the pages.

#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.

#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.

#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will

# contain a <link> tag referring to it.  The value of this option must be the

# base URL from which the finished HTML is served.

#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").

#html_file_suffix = None

# Language to be used for generating the HTML full-text search index.

# Sphinx supports the following languages:

#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'

#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'

#html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.

# Now only 'ja' uses this config value

#html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that

# implements a search results scorer. If empty, the default will be used.

#html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.

htmlhelp_basename = 'TheLinuxKerneldoc'

# -- 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, 'TheLinuxKernel.tex', 'The Linux Kernel Documentation',

     'The kernel development community', 'manual'),

]

# The name of an image file (relative to this directory) to place at the top of

# the title page.

#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,

# not chapters.

#latex_use_parts = False

# If true, show page references after internal links.

#latex_show_pagerefs = False

# If true, show URL addresses after external links.

#latex_show_urls = False

# Documents to append as an appendix to all manuals.

#latex_appendices = []

# If false, no module index is generated.

#latex_domain_indices = True

# -- 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, 'thelinuxkernel', 'The Linux Kernel Documentation',

     [author], 1)

]

# If true, show URL addresses after external links.

#man_show_urls = False

# -- 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, 'TheLinuxKernel', 'The Linux Kernel Documentation',

     author, 'TheLinuxKernel', 'One line description of project.',

     'Miscellaneous'),

]

# Documents to append as an appendix to all manuals.

#texinfo_appendices = []

# If false, no module index is generated.

#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.

#texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.

#texinfo_no_detailmenu = False

# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.

epub_title = project

epub_author = author

epub_publisher = author

epub_copyright = copyright

# The basename for the epub file. It defaults to the project name.

#epub_basename = project

# The HTML theme for the epub output. Since the default themes are not

# optimized for small screen space, using the same theme for HTML and epub

# output is usually not wise. This defaults to 'epub', a theme designed to save

# visual space.

#epub_theme = 'epub'

# The language of the text. It defaults to the language option

# or 'en' if the language is not set.

#epub_language = ''

# The scheme of the identifier. Typical schemes are ISBN or URL.

#epub_scheme = ''

# The unique identifier of the text. This can be a ISBN number

# or the project homepage.

#epub_identifier = ''

# A unique identification for the text.

#epub_uid = ''

# A tuple containing the cover image and cover page html template filenames.

#epub_cover = ()

# A sequence of (type, uri, title) tuples for the guide element of content.opf.

#epub_guide = ()

# HTML files that should be inserted before the pages created by sphinx.

# The format is a list of tuples containing the path and title.

#epub_pre_files = []

# HTML files that should be inserted after the pages created by sphinx.

# The format is a list of tuples containing the path and title.

#epub_post_files = []

# A list of files that should not be packed into the epub file.

epub_exclude_files = ['search.html']

# The depth of the table of contents in toc.ncx.

#epub_tocdepth = 3

# Allow duplicate toc entries.

#epub_tocdup = True

# Choose between 'default' and 'includehidden'.

#epub_tocscope = 'default'

# Fix unsupported image types using the Pillow.

#epub_fix_images = False

# Scale large images.

#epub_max_image_width = 0

# How to display URL addresses: 'footnote', 'no', or 'inline'.

#epub_show_urls = 'inline'

# If false, no index is generated.

#epub_use_index = True

#=======

# rst2pdf

#

# Grouping the document tree into PDF files. List of tuples

# (source start file, target name, title, author, options).

#

# See the Sphinx chapter of http://ralsina.me/static/manual.pdf

#

# FIXME: Do not add the index file here; the result will be too big. Adding

# multiple PDF files here actually tries to get the cross-referencing right

# *between* PDF files.

pdf_documents = [

    ('index', u'Kernel', u'Kernel', u'J. Random Bozo'),

]

# kernel-doc extension configuration for running Sphinx directly (e.g. by Read

# the Docs). In a normal build, these are supplied from the Makefile via command

# line arguments.

kerneldoc_bin = '../scripts/kernel-doc'

kerneldoc_srctree = '..'

.. The Linux Kernel documentation master file, created by

   sphinx-quickstart on Fri Feb 12 13:51:46 2016.

   You can adapt this file completely to your liking, but it should at least

   contain the root `toctree` directive.

Welcome to The Linux Kernel's documentation!

============================================

Nothing for you to see here *yet*. Please move along.

Contents:

.. toctree::

   :maxdepth: 2

Indices and tables

==================

* :ref:`genindex`

* :ref:`modindex`

* :ref:`search`