From abdcc8d17c066b2b96155f43d4b7a7ea40ea54ae Mon Sep 17 00:00:00 2001 From: raiden00pl Date: Tue, 24 Oct 2023 12:51:23 +0200 Subject: [PATCH] Documentation: unify applications/xxx/index.rst --- Documentation/applications/audioutils/index.rst | 5 +++-- Documentation/applications/boot/index.rst | 5 +++-- Documentation/applications/crypto/index.rst | 5 +++-- Documentation/applications/examples/index.rst | 5 +++-- Documentation/applications/fsutils/index.rst | 5 +++-- Documentation/applications/games/index.rst | 1 + Documentation/applications/graphics/index.rst | 7 ++++--- Documentation/applications/industry/index.rst | 5 +++-- Documentation/applications/interpreters/index.rst | 5 +++-- Documentation/applications/logging/index.rst | 5 +++-- Documentation/applications/netutils/index.rst | 5 +++-- Documentation/applications/system/index.rst | 3 ++- Documentation/applications/testing/index.rst | 5 +++-- Documentation/applications/wireless/index.rst | 1 + 14 files changed, 38 insertions(+), 24 deletions(-) diff --git a/Documentation/applications/audioutils/index.rst b/Documentation/applications/audioutils/index.rst index 5aca2ab1b9..23f456aed9 100644 --- a/Documentation/applications/audioutils/index.rst +++ b/Documentation/applications/audioutils/index.rst @@ -4,10 +4,11 @@ Audio Utility libraries .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: + :caption: Contents - */* + */index* - fmsynth - FM Synthesizer Library - nxaudio - NX Audio Library diff --git a/Documentation/applications/boot/index.rst b/Documentation/applications/boot/index.rst index d70a419ac6..128234a1de 100644 --- a/Documentation/applications/boot/index.rst +++ b/Documentation/applications/boot/index.rst @@ -4,7 +4,8 @@ Bootloader Utilities .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: + :caption: Contents - */* + */index* diff --git a/Documentation/applications/crypto/index.rst b/Documentation/applications/crypto/index.rst index f7d9420fb9..536936c851 100644 --- a/Documentation/applications/crypto/index.rst +++ b/Documentation/applications/crypto/index.rst @@ -4,10 +4,11 @@ Cryptography Library Support .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: + :caption: Contents - wolfssl/index.rst + */index* - controlse - Control Secure Element device - libsodium - Libsodium Cryptography Library diff --git a/Documentation/applications/examples/index.rst b/Documentation/applications/examples/index.rst index ba7b557c96..a47509d910 100644 --- a/Documentation/applications/examples/index.rst +++ b/Documentation/applications/examples/index.rst @@ -33,7 +33,8 @@ Supported examples .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: + :caption: Contents - */* + */index* diff --git a/Documentation/applications/fsutils/index.rst b/Documentation/applications/fsutils/index.rst index 965afc4adc..d1ed4182aa 100644 --- a/Documentation/applications/fsutils/index.rst +++ b/Documentation/applications/fsutils/index.rst @@ -4,10 +4,11 @@ File System Utilities .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: + :caption: Contents - */* + */index* - flash_eraseall - flash_eraseall() function - inih - inih ini file parser diff --git a/Documentation/applications/games/index.rst b/Documentation/applications/games/index.rst index 9eb7a93c21..d7a38840ca 100644 --- a/Documentation/applications/games/index.rst +++ b/Documentation/applications/games/index.rst @@ -15,5 +15,6 @@ to Doom in many ways. That game is not part of Apache NuttX. :glob: :maxdepth: 1 :titlesonly: + :caption: Contents */index* diff --git a/Documentation/applications/graphics/index.rst b/Documentation/applications/graphics/index.rst index 92779321fc..91c9c4eebe 100644 --- a/Documentation/applications/graphics/index.rst +++ b/Documentation/applications/graphics/index.rst @@ -4,10 +4,11 @@ Graphics Support .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: - - */* + :caption: Contents + + */index* - ft80x - FTDI/BridgeTek FT80x library - libjpeg - libjpeg JPEG image encoding diff --git a/Documentation/applications/industry/index.rst b/Documentation/applications/industry/index.rst index 5622707dbc..76721d705f 100644 --- a/Documentation/applications/industry/index.rst +++ b/Documentation/applications/industry/index.rst @@ -4,10 +4,11 @@ Industrial Applications .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: + :caption: Contents - */* + */index* - foc - Field Oriented Control user-space library - scpi - SCPI instrument side parser diff --git a/Documentation/applications/interpreters/index.rst b/Documentation/applications/interpreters/index.rst index ec0a879c09..db7ff68cdc 100644 --- a/Documentation/applications/interpreters/index.rst +++ b/Documentation/applications/interpreters/index.rst @@ -7,10 +7,11 @@ incorporated into NuttX. .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: + :caption: Contents - */* + */index* - duktape - Duktape JavaScript interpreter - luajit - LuaJIT interpreter diff --git a/Documentation/applications/logging/index.rst b/Documentation/applications/logging/index.rst index bd79b7ca98..9d9cae828f 100644 --- a/Documentation/applications/logging/index.rst +++ b/Documentation/applications/logging/index.rst @@ -4,7 +4,8 @@ Logging Utilities .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: + :caption: Contents - */* + */index* diff --git a/Documentation/applications/netutils/index.rst b/Documentation/applications/netutils/index.rst index 610cc4a3b4..32bbdd39da 100644 --- a/Documentation/applications/netutils/index.rst +++ b/Documentation/applications/netutils/index.rst @@ -4,10 +4,11 @@ Network Utilities .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: + :caption: Contents - */* + */index* - chat - Chat tool diff --git a/Documentation/applications/system/index.rst b/Documentation/applications/system/index.rst index 942369a5d3..919ede8d9f 100644 --- a/Documentation/applications/system/index.rst +++ b/Documentation/applications/system/index.rst @@ -4,8 +4,9 @@ System Libraries and NSH Add-Ons .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: + :caption: Contents */index* diff --git a/Documentation/applications/testing/index.rst b/Documentation/applications/testing/index.rst index 9bca51ff56..6378d13427 100644 --- a/Documentation/applications/testing/index.rst +++ b/Documentation/applications/testing/index.rst @@ -13,10 +13,11 @@ with little value as usage examples. .. toctree:: :glob: - :maxdepth: 3 + :maxdepth: 1 :titlesonly: + :caption: Contents - */* + */index* - atomic - "Test atomic" testing - batterydump - Battery dump for test diff --git a/Documentation/applications/wireless/index.rst b/Documentation/applications/wireless/index.rst index bcb2c2ee67..2e41494f10 100644 --- a/Documentation/applications/wireless/index.rst +++ b/Documentation/applications/wireless/index.rst @@ -6,6 +6,7 @@ Wireless Libraries and NSH Add-Ons :glob: :maxdepth: 1 :titlesonly: + :caption: Contents */index*