[PATCH] Documentation: driver-api: usb: Limit toctree depth

Bagas Sanjaya posted 1 patch 1 month, 2 weeks ago
Documentation/driver-api/usb/index.rst | 1 +
1 file changed, 1 insertion(+)
[PATCH] Documentation: driver-api: usb: Limit toctree depth
Posted by Bagas Sanjaya 1 month, 2 weeks ago
toctree index in USB driver api docs currently spoils the entire docs
headings due to lack of :maxdepth: option. Add the option to limit
toctree depth to 1, mirroring usb subsystem docs in
Documentation/usb/index.rst.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/driver-api/usb/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/driver-api/usb/index.rst b/Documentation/driver-api/usb/index.rst
index cfa8797ea6144b..fcb24d0500d91d 100644
--- a/Documentation/driver-api/usb/index.rst
+++ b/Documentation/driver-api/usb/index.rst
@@ -3,6 +3,7 @@ Linux USB API
 =============
 
 .. toctree::
+   :maxdepth: 1
 
    usb
    gadget

base-commit: 37c52167b007d9d0bb8c5ed53dd6efc4969a1356
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH] Documentation: driver-api: usb: Limit toctree depth
Posted by Jonathan Corbet 1 month, 1 week ago
Bagas Sanjaya <bagasdotme@gmail.com> writes:

> toctree index in USB driver api docs currently spoils the entire docs
> headings due to lack of :maxdepth: option. Add the option to limit
> toctree depth to 1, mirroring usb subsystem docs in
> Documentation/usb/index.rst.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/driver-api/usb/index.rst | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/driver-api/usb/index.rst b/Documentation/driver-api/usb/index.rst
> index cfa8797ea6144b..fcb24d0500d91d 100644
> --- a/Documentation/driver-api/usb/index.rst
> +++ b/Documentation/driver-api/usb/index.rst
> @@ -3,6 +3,7 @@ Linux USB API
>  =============
>  
>  .. toctree::
> +   :maxdepth: 1
>  

It's still kind of a mess, but that does make it better.  Applied,
thanks.

jon