linux/Documentation/media/index.rst

.. SPDX-License-Identifier: GPL-2.0

Linux Media Subsystem Documentation
===================================

.. only:: html

   .. class:: toc-title

        Table of Contents

.. toctree::
   :maxdepth: 2

   media_uapi
   media_kapi
   dvb-drivers/index
   v4l-drivers/index
   cec-drivers/index

.. only:: html and subproject

   Indices
   =======

   * :ref:`genindex`
media: docs: brainless mass add SPDX headers to all media files All Documentation files outside the uAPI are all licensed with, at least, GPL 2.0. So, mark them as such. The ondes at media/uapi are at least GFDL 1.1+. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> 2018-08-30 14:20:04 +00:00			`.. SPDX-License-Identifier: GPL-2.0`

doc-rst: add stand-alone conf.py to media folder With the media/conf.py, and media/index.rst the media folder can be build and distributed stand-alone. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-08-13 14:12:43 +00:00			`Linux Media Subsystem Documentation`
			`===================================`

media: index.rst: don't write "Contents:" on PDF output Right now, Sphinx unconditionally creates a blank page with just "Contents:" on it, on PDF output. While this makes sense for html, it doesn't o PDF, as LaTeX does what's required automatically. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2017-09-03 18:39:51 +00:00			`.. only:: html`

			`.. class:: toc-title`

			`Table of Contents`
doc-rst: add stand-alone conf.py to media folder With the media/conf.py, and media/index.rst the media folder can be build and distributed stand-alone. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-08-13 14:12:43 +00:00
			`.. toctree::`
			`:maxdepth: 2`

			`media_uapi`
			`media_kapi`
			`dvb-drivers/index`
			`v4l-drivers/index`
media: pulse8-cec.rst: add documentation for the pulse8-cec driver Document the persistent_config module option. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2017-07-16 08:18:50 +00:00			`cec-drivers/index`
doc-rst: add index to sub-folders Add a index if only a sub-folder is build e.g.:: make SPHINXDIRS=media cleandocs htmldocs BTW: removed dead search link in the top-index file Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-08-15 15:15:59 +00:00
media: index.rst: exclude Indexes section from latex/pdf output With LaTex, the Index at the end will always be present. Having an extra chapter for it there will just add extra noise to the document. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> 2019-03-30 13:33:54 +00:00			`.. only:: html and subproject`
doc-rst: add index to sub-folders Add a index if only a sub-folder is build e.g.:: make SPHINXDIRS=media cleandocs htmldocs BTW: removed dead search link in the top-index file Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-08-15 15:15:59 +00:00
			`Indices`
			`=======`

			* :ref:`genindex`