From: Thomas Monjalon <thomas@monjalon.net>
To: dev@dpdk.org
Subject: [PATCH] doc: reduce index depth of most guides
Date: Mon, 14 Apr 2025 10:45:30 +0200 [thread overview]
Message-ID: <20250414084531.1759703-1-thomas@monjalon.net> (raw)
The guides having a diverse list of multiple drivers or tools
are easier to browse with an index limited
to the first headings (depth 1).
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
doc/guides/bbdevs/index.rst | 2 +-
doc/guides/compressdevs/index.rst | 2 +-
doc/guides/cryptodevs/index.rst | 2 +-
doc/guides/dmadevs/index.rst | 2 +-
doc/guides/eventdevs/index.rst | 2 +-
doc/guides/faq/index.rst | 2 +-
doc/guides/gpus/index.rst | 2 +-
doc/guides/howto/index.rst | 2 +-
doc/guides/mempool/index.rst | 2 +-
doc/guides/mldevs/index.rst | 2 +-
doc/guides/nics/index.rst | 2 +-
doc/guides/platform/index.rst | 2 +-
doc/guides/rawdevs/index.rst | 2 +-
doc/guides/regexdevs/index.rst | 2 +-
doc/guides/sample_app_ug/index.rst | 2 +-
doc/guides/tools/index.rst | 2 +-
doc/guides/vdpadevs/index.rst | 2 +-
17 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/doc/guides/bbdevs/index.rst b/doc/guides/bbdevs/index.rst
index 269157d77f..d833bbeff0 100644
--- a/doc/guides/bbdevs/index.rst
+++ b/doc/guides/bbdevs/index.rst
@@ -5,7 +5,7 @@ Baseband Device Drivers
=======================
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
overview
diff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst
index bab226ffbc..4dcc7d3831 100644
--- a/doc/guides/compressdevs/index.rst
+++ b/doc/guides/compressdevs/index.rst
@@ -6,7 +6,7 @@ Compression Device Drivers
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
overview
diff --git a/doc/guides/cryptodevs/index.rst b/doc/guides/cryptodevs/index.rst
index 1e57a9fe86..5ddfc46a63 100644
--- a/doc/guides/cryptodevs/index.rst
+++ b/doc/guides/cryptodevs/index.rst
@@ -6,7 +6,7 @@ Crypto Device Drivers
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
overview
diff --git a/doc/guides/dmadevs/index.rst b/doc/guides/dmadevs/index.rst
index ce9f6eb260..15ddaf5192 100644
--- a/doc/guides/dmadevs/index.rst
+++ b/doc/guides/dmadevs/index.rst
@@ -8,7 +8,7 @@ The following are a list of DMA device drivers, which can be used from
an application through DMA API.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
cnxk
diff --git a/doc/guides/eventdevs/index.rst b/doc/guides/eventdevs/index.rst
index eed19ad28c..69a5ebf812 100644
--- a/doc/guides/eventdevs/index.rst
+++ b/doc/guides/eventdevs/index.rst
@@ -8,7 +8,7 @@ The following are a list of event device PMDs, which can be used from an
application through the eventdev API.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
overview
diff --git a/doc/guides/faq/index.rst b/doc/guides/faq/index.rst
index a9ae9bddd4..191953e940 100644
--- a/doc/guides/faq/index.rst
+++ b/doc/guides/faq/index.rst
@@ -7,7 +7,7 @@ FAQ
This document contains some Frequently Asked Questions that arise when working with DPDK.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
faq
diff --git a/doc/guides/gpus/index.rst b/doc/guides/gpus/index.rst
index 4b7a420556..bc82ae3be2 100644
--- a/doc/guides/gpus/index.rst
+++ b/doc/guides/gpus/index.rst
@@ -5,7 +5,7 @@ General-Purpose Graphics Processing Unit Drivers
================================================
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
overview
diff --git a/doc/guides/howto/index.rst b/doc/guides/howto/index.rst
index ee80849e7b..c9117a0fe4 100644
--- a/doc/guides/howto/index.rst
+++ b/doc/guides/howto/index.rst
@@ -5,7 +5,7 @@ HowTo Guides
============
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
af_xdp_dp
diff --git a/doc/guides/mempool/index.rst b/doc/guides/mempool/index.rst
index e4b6ee7d31..a731e61587 100644
--- a/doc/guides/mempool/index.rst
+++ b/doc/guides/mempool/index.rst
@@ -8,7 +8,7 @@ The following are a list of mempool PMDs, which can be used from an
application through the mempool API.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
cnxk
diff --git a/doc/guides/mldevs/index.rst b/doc/guides/mldevs/index.rst
index 00e7795ec1..754b3d9705 100644
--- a/doc/guides/mldevs/index.rst
+++ b/doc/guides/mldevs/index.rst
@@ -8,7 +8,7 @@ The following are a list of ML device PMDs,
which can be used from an application through the ML device API.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
cnxk
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index 10a2eca3b0..9f1bf567cb 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -5,7 +5,7 @@ Network Interface Controller Drivers
====================================
.. toctree::
- :maxdepth: 3
+ :maxdepth: 1
:numbered:
overview
diff --git a/doc/guides/platform/index.rst b/doc/guides/platform/index.rst
index b1ba11df73..d44cbdc8e3 100644
--- a/doc/guides/platform/index.rst
+++ b/doc/guides/platform/index.rst
@@ -7,7 +7,7 @@ Platform Specific Guides
The following are platform specific guides and setup information.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
bluefield
diff --git a/doc/guides/rawdevs/index.rst b/doc/guides/rawdevs/index.rst
index 804fa5365a..8d8aae0834 100644
--- a/doc/guides/rawdevs/index.rst
+++ b/doc/guides/rawdevs/index.rst
@@ -8,7 +8,7 @@ The following are a list of raw device PMDs, which can be used from an
application through rawdev API.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
cnxk_bphy
diff --git a/doc/guides/regexdevs/index.rst b/doc/guides/regexdevs/index.rst
index 9c88300bff..4f928f919b 100644
--- a/doc/guides/regexdevs/index.rst
+++ b/doc/guides/regexdevs/index.rst
@@ -8,7 +8,7 @@ The following are a list of RegEx (Regular Expression) device drivers,
which can be used from an application through RegEx API.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
features_overview
diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst
index 21ee35cc8b..e895f692f9 100644
--- a/doc/guides/sample_app_ug/index.rst
+++ b/doc/guides/sample_app_ug/index.rst
@@ -5,7 +5,7 @@ Sample Applications User Guides
===============================
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
intro
diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst
index 4f4dc8b518..8ec429ec53 100644
--- a/doc/guides/tools/index.rst
+++ b/doc/guides/tools/index.rst
@@ -5,7 +5,7 @@ DPDK Tools User Guides
======================
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
hugepages
diff --git a/doc/guides/vdpadevs/index.rst b/doc/guides/vdpadevs/index.rst
index b0191a3a1d..ddbeb6c026 100644
--- a/doc/guides/vdpadevs/index.rst
+++ b/doc/guides/vdpadevs/index.rst
@@ -8,7 +8,7 @@ The following are a list of vDPA (vHost Data Path Acceleration) device drivers,
which can be used from an application through vhost API.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:numbered:
features_overview
--
2.47.1
reply other threads:[~2025-04-14 8:56 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250414084531.1759703-1-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=dev@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).