[PATCH 3/3] Documentation: fb: Split toctree

Bagas Sanjaya posted 3 patches 1 week, 6 days ago
There is a newer version of this series
[PATCH 3/3] Documentation: fb: Split toctree
Posted by Bagas Sanjaya 1 week, 6 days ago
Framebuffer docs toctree consists of driver-independent docs
(e.g. API docs) and driver-specific docs. The latter has much
more entries.

Group the docs into separate toctrees.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/fb/index.rst | 80 +++++++++++++++++++++-----------------
 1 file changed, 45 insertions(+), 35 deletions(-)

diff --git a/Documentation/fb/index.rst b/Documentation/fb/index.rst
index 33e3c49f885695..e2f7488b6e2e42 100644
--- a/Documentation/fb/index.rst
+++ b/Documentation/fb/index.rst
@@ -4,42 +4,52 @@
 Frame Buffer
 ============
 
-.. toctree::
-    :maxdepth: 1
+General information
+===================
 
-    api
-    arkfb
-    aty128fb
-    cirrusfb
-    cmap_xfbdev
-    deferred_io
-    efifb
-    ep93xx-fb
-    fbcon
-    framebuffer
-    gxfb
-    intel810
-    internals
-    lxfb
-    matroxfb
-    metronomefb
-    modedb
-    pvr2fb
-    pxafb
-    s3fb
-    sa1100fb
-    sh7760fb
-    sisfb
-    sm501
-    sm712fb
-    sstfb
-    tgafb
-    tridentfb
-    udlfb
-    uvesafb
-    vesafb
-    viafb
-    vt8623fb
+.. toctree::
+   :maxdepth: 1
+
+   api
+   cmap_xfbdev
+   deferred_io
+   fbcon
+   framebuffer
+   internals
+   modedb
+
+Driver documentation
+====================
+
+.. toctree::
+   :maxdepth: 1
+
+   arkfb
+   aty128fb
+   cirrusfb
+   efifb
+   ep93xx-fb
+   gxfb
+   intel810
+   lxfb
+   matroxfb
+   metronomefb
+   pvr2fb
+   pxafb
+   s3fb
+   sa1100fb
+   sh7760fb
+   sisfb
+   sm501
+   sm712fb
+   sstfb
+   tgafb
+   tridentfb
+   udlfb
+   uvesafb
+   vesafb
+   viafb
+   vt8623fb
 
 .. only::  subproject and html
 
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH 3/3] Documentation: fb: Split toctree
Posted by Randy Dunlap 1 week, 4 days ago

On 9/18/25 5:36 PM, Bagas Sanjaya wrote:
> Framebuffer docs toctree consists of driver-independent docs
> (e.g. API docs) and driver-specific docs. The latter has much
> more entries.
> 
> Group the docs into separate toctrees.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

LGTM. Thanks.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

> ---
>  Documentation/fb/index.rst | 80 +++++++++++++++++++++-----------------
>  1 file changed, 45 insertions(+), 35 deletions(-)
> 
> diff --git a/Documentation/fb/index.rst b/Documentation/fb/index.rst
> index 33e3c49f885695..e2f7488b6e2e42 100644
> --- a/Documentation/fb/index.rst
> +++ b/Documentation/fb/index.rst
> @@ -4,42 +4,52 @@
>  Frame Buffer
>  ============
>  
> -.. toctree::
> -    :maxdepth: 1
> +General information
> +===================
>  
> -    api
> -    arkfb
> -    aty128fb
> -    cirrusfb
> -    cmap_xfbdev
> -    deferred_io
> -    efifb
> -    ep93xx-fb
> -    fbcon
> -    framebuffer
> -    gxfb
> -    intel810
> -    internals
> -    lxfb
> -    matroxfb
> -    metronomefb
> -    modedb
> -    pvr2fb
> -    pxafb
> -    s3fb
> -    sa1100fb
> -    sh7760fb
> -    sisfb
> -    sm501
> -    sm712fb
> -    sstfb
> -    tgafb
> -    tridentfb
> -    udlfb
> -    uvesafb
> -    vesafb
> -    viafb
> -    vt8623fb
> +.. toctree::
> +   :maxdepth: 1
> +
> +   api
> +   cmap_xfbdev
> +   deferred_io
> +   fbcon
> +   framebuffer
> +   internals
> +   modedb
> +
> +Driver documentation
> +====================
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   arkfb
> +   aty128fb
> +   cirrusfb
> +   efifb
> +   ep93xx-fb
> +   gxfb
> +   intel810
> +   lxfb
> +   matroxfb
> +   metronomefb
> +   pvr2fb
> +   pxafb
> +   s3fb
> +   sa1100fb
> +   sh7760fb
> +   sisfb
> +   sm501
> +   sm712fb
> +   sstfb
> +   tgafb
> +   tridentfb
> +   udlfb
> +   uvesafb
> +   vesafb
> +   viafb
> +   vt8623fb
>  
>  .. only::  subproject and html
>  

-- 
~Randy