summaryrefslogtreecommitdiffstats
path: root/Documentation/media/media_uapi.rst
Commit message (Collapse)AuthorAgeFilesLines
* media: docs: don't show ToC for each part on PDF outputMauro Carvalho Chehab2017-09-051-1/+3
| | | | | | | | | | The "Table of Contents" of a PDF file is generated only once, at the beginning fo the output. It doesn't produce it on each part. So, don't output this text on each part of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: better organize the media booksMauro Carvalho Chehab2016-07-231-1/+1
| | | | | | | | | | | | | | | 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>
* [media] doc-rst: backward compatibility with older Sphinx versionsMauro Carvalho Chehab2016-07-191-2/+3
| | | | | | | | | | | | Sphinx is really evil when an older version finds an extra attribute for the :toctree: tag: it simply ignores everything and produce documents without any chapter inside! As we're now using tags available only on Sphinx 1.4.x, we need to use some creative ways to add a title before the table of contents. Do that by using a css class. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: better name the media booksMauro Carvalho Chehab2016-07-181-5/+5
| | | | | | | | | | | The titles at the media books were misleading, and some books were not numbered. Rename the kAPI book to better reflect its contents, be more consistent on the initial rst file for each book and better name them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: increase depth of the main indexMauro Carvalho Chehab2016-07-131-8/+3
| | | | | | | | | | It is useful to have an index with all the book contents somewhere, as it makes easier to seek for something. So, increase maxdepth to 5 for the main index at the beginning of the book. While here, remove the genindex content, as it is bogus. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: media: reordered top sectioningMarkus Heiser2016-07-091-52/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | Within the old section hierarchy, all doc parts has been placed under the introduction, e.g: * Linux Media Infrastructure API + Introduction - Video for Linux API - Digital TV API - ... With separating the introduction sibling to the other parts we get a more common section hierarchy: * Linux Media Infrastructure API + Introduction + Video for Linux API + Digital TV API + ... BTW: compacting the intro text. This patch is on top of media_tree/docs-next Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
* [media] doc-rst: linux_tv CEC part, DocBook to reST migrationMarkus Heiser2016-07-081-5/+8
| | | | | | | | | | | | This is the reST migration of media's CEC part. The migration is based on media_tree's cec branch: https://git.linuxtv.org/media_tree.git c7169ad * cec media_tree/cec [media] DocBook/media: add CEC documentation Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* doc_rst: rename the media Sphinx suff to Documentation/mediaMauro Carvalho Chehab2016-07-081-0/+83
The name of the subsystem is "media", and not "linux_tv". Also, as we plan to add other stuff there in the future, let's rename also the media uAPI book to media_uapi, to make it clearer. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-18 12:40:14 +0000