Re: [PATCH 2/2] [media] doc-rst: increase depth of the main index

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Mauro,

Am 13.07.2016 um 15:52 schrieb Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>:

> 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@xxxxxxxxxxxxxxxx>
> ---
> Documentation/media/media_uapi.rst | 11 +++--------
> 1 file changed, 3 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/media/media_uapi.rst b/Documentation/media/media_uapi.rst
> index 527c6deb1a19..5e872c8297b0 100644
> --- a/Documentation/media/media_uapi.rst
> +++ b/Documentation/media/media_uapi.rst
> @@ -15,8 +15,10 @@ the license is included in the chapter entitled "GNU Free Documentation
> License".
> 
> 
> +.. contents::
> +

Since there is a ".. toctree" with maxdepth, you don't need
this ".. contents::" directive.

The ".. contents::" directive is helpfull if you want to show
the contents (e.g.) on top of a file which has no toctree in.

-- Markus --

> .. toctree::
> -    :maxdepth: 1
> +    :maxdepth: 5
> 
>     intro
>     uapi/v4l/v4l2
> @@ -26,10 +28,3 @@ License".
>     uapi/cec/cec-api
>     uapi/gen-errors
>     uapi/fdl-appendix
> -
> -.. only:: html
> -
> -  Retrieval
> -  =========
> -
> -  * :ref:`genindex`
> -- 
> 2.7.4
> 
> --
> To unsubscribe from this list: send the line "unsubscribe linux-media" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux