From 7108ee6bcf0c54278cf93b1c28afc1eea76947d3 Mon Sep 17 00:00:00 2001 From: Jorge Marques Date: Thu, 9 Jan 2025 15:46:16 +0100 Subject: [PATCH] docs: Use toctree glob for ip/project_based Most merge conflicts are just the inclusion at the toctree in alphabetical order, by using glob, we can mitigate them. To not include the orphan templates, rename them to _index. Also remove dangling orphan empty project ad7616. Signed-off-by: Jorge Marques --- docs/testbenches/ip_based/index.rst | 5 ++--- .../ip_based/template/{index.rst => _index.rst} | 0 docs/testbenches/project_based/ad7616/index.rst | 9 --------- docs/testbenches/project_based/index.rst | 6 ++---- .../project_based/template/{index.rst => _index.rst} | 0 5 files changed, 4 insertions(+), 16 deletions(-) rename docs/testbenches/ip_based/template/{index.rst => _index.rst} (100%) delete mode 100644 docs/testbenches/project_based/ad7616/index.rst rename docs/testbenches/project_based/template/{index.rst => _index.rst} (100%) diff --git a/docs/testbenches/ip_based/index.rst b/docs/testbenches/ip_based/index.rst index df88ecf4..c239b338 100644 --- a/docs/testbenches/ip_based/index.rst +++ b/docs/testbenches/ip_based/index.rst @@ -8,7 +8,6 @@ Contents .. toctree:: :maxdepth: 1 + :glob: - axis_sequencers/index - base/index - util_pack/index + */index diff --git a/docs/testbenches/ip_based/template/index.rst b/docs/testbenches/ip_based/template/_index.rst similarity index 100% rename from docs/testbenches/ip_based/template/index.rst rename to docs/testbenches/ip_based/template/_index.rst diff --git a/docs/testbenches/project_based/ad7616/index.rst b/docs/testbenches/project_based/ad7616/index.rst deleted file mode 100644 index ddb1182c..00000000 --- a/docs/testbenches/project_based/ad7616/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -:orphan: - -.. _ad7616: - -AD7616 Test bench -================================================================================ - -Overview -------------------------------------------------------------------------------- diff --git a/docs/testbenches/project_based/index.rst b/docs/testbenches/project_based/index.rst index b8f18c32..30336d3f 100644 --- a/docs/testbenches/project_based/index.rst +++ b/docs/testbenches/project_based/index.rst @@ -8,8 +8,6 @@ Contents .. toctree:: :maxdepth: 1 + :glob: - ad463x/index - ad738x/index - ad7606/index - pulsar_adc/index + */index diff --git a/docs/testbenches/project_based/template/index.rst b/docs/testbenches/project_based/template/_index.rst similarity index 100% rename from docs/testbenches/project_based/template/index.rst rename to docs/testbenches/project_based/template/_index.rst