diff options
| author | Mauro Carvalho Chehab | 2016-07-20 15:36:18 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab | 2016-07-23 13:03:24 +0200 |
| commit | da83c888bfa5bee632953c57940c24846bb46965 (patch) | |
| tree | 4f5152b13e98f29341eae96587fc0826da819bc1 /Documentation/media/uapi | |
| parent | [media] doc-rst: Fix some Sphinx warnings (diff) | |
| download | kernel-qcow2-linux-da83c888bfa5bee632953c57940c24846bb46965.tar.gz kernel-qcow2-linux-da83c888bfa5bee632953c57940c24846bb46965.tar.xz kernel-qcow2-linux-da83c888bfa5bee632953c57940c24846bb46965.zip | |
[media] doc-rst: better organize the media books
The uAPI book has 5 parts, but they lost numeration after
conversion to rst. Manually number those parts, and make
the main index with 1 depth, to only show the parts and
the annexes.
At each part, use :maxwidth: 5, in order to show a more
complete index.
While here, fix the cross-references between different
books.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi')
| -rw-r--r-- | Documentation/media/uapi/cec/cec-api.rst | 14 | ||||
| -rw-r--r-- | Documentation/media/uapi/dvb/dvbapi.rst | 12 | ||||
| -rw-r--r-- | Documentation/media/uapi/mediactl/media-controller.rst | 17 | ||||
| -rw-r--r-- | Documentation/media/uapi/rc/remote_controllers.rst | 17 | ||||
| -rw-r--r-- | Documentation/media/uapi/v4l/v4l2.rst | 12 |
5 files changed, 38 insertions, 34 deletions
diff --git a/Documentation/media/uapi/cec/cec-api.rst b/Documentation/media/uapi/cec/cec-api.rst index 246fbae2e079..bb018709970c 100644 --- a/Documentation/media/uapi/cec/cec-api.rst +++ b/Documentation/media/uapi/cec/cec-api.rst @@ -4,16 +4,18 @@ .. _cec: -####### -CEC API -####### - -.. _cec-api: +######################################### +Part V - Consumer Electronics Control API +######################################### This part describes the CEC: Consumer Electronics Control +.. class:: toc-title + + Table of Contents + .. toctree:: - :maxdepth: 1 + :maxdepth: 5 :numbered: cec-intro diff --git a/Documentation/media/uapi/dvb/dvbapi.rst b/Documentation/media/uapi/dvb/dvbapi.rst index 6c06147f167c..48e61aba741e 100644 --- a/Documentation/media/uapi/dvb/dvbapi.rst +++ b/Documentation/media/uapi/dvb/dvbapi.rst @@ -4,17 +4,21 @@ .. _dvbapi: -############## -Digital TV API -############## +######################## +Part II - Digital TV API +######################## .. note:: This API is also known as **DVB API**, although it is generic enough to support all digital TV standards. **Version 5.10** +.. class:: toc-title + + Table of Contents + .. toctree:: - :maxdepth: 1 + :maxdepth: 5 :numbered: intro diff --git a/Documentation/media/uapi/mediactl/media-controller.rst b/Documentation/media/uapi/mediactl/media-controller.rst index 7e08c93a15ab..7ae38d48969e 100644 --- a/Documentation/media/uapi/mediactl/media-controller.rst +++ b/Documentation/media/uapi/mediactl/media-controller.rst @@ -2,21 +2,18 @@ .. include:: <isonum.txt> -.. _media_common: - -#################### -Media Controller API -#################### - .. _media_controller: -**************** -Media Controller -**************** +############################## +Part IV - Media Controller API +############################## + +.. class:: toc-title + Table of Contents .. toctree:: - :maxdepth: 1 + :maxdepth: 5 :numbered: media-controller-intro diff --git a/Documentation/media/uapi/rc/remote_controllers.rst b/Documentation/media/uapi/rc/remote_controllers.rst index 169286501ebb..3e25cc9f65e0 100644 --- a/Documentation/media/uapi/rc/remote_controllers.rst +++ b/Documentation/media/uapi/rc/remote_controllers.rst @@ -2,21 +2,18 @@ .. include:: <isonum.txt> -.. _remotes: - -##################### -Remote Controller API -##################### - .. _remote_controllers: -****************** -Remote Controllers -****************** +################################ +Part III - Remote Controller API +################################ + +.. class:: toc-title + Table of Contents .. toctree:: - :maxdepth: 1 + :maxdepth: 5 :numbered: rc-intro diff --git a/Documentation/media/uapi/v4l/v4l2.rst b/Documentation/media/uapi/v4l/v4l2.rst index c0859ebc88ee..5e41a8505301 100644 --- a/Documentation/media/uapi/v4l/v4l2.rst +++ b/Documentation/media/uapi/v4l/v4l2.rst @@ -3,17 +3,21 @@ .. include:: <isonum.txt> .. _v4l2spec: -################### -Video for Linux API -################### +############################ +Part I - Video for Linux API +############################ This part describes the Video for Linux API version 2 (V4L2 API) specification. **Revision 4.5** +.. class:: toc-title + + Table of Contents + .. toctree:: :numbered: - :maxdepth: 1 + :maxdepth: 5 common pixfmt |