From 118bf9b52daa71f00f9a1189db6ae4765be9e6b1 Mon Sep 17 00:00:00 2001 From: hanzj Date: Wed, 3 Jun 2026 07:29:25 +0800 Subject: [PATCH] docs: Fix duplicate toctree references causing build warnings Several documentation files are referenced in multiple toctrees, causing Sphinx build warnings like: document is referenced in multiple toctrees: [...], selecting: [...] Fix by narrowing glob patterns in parent toctrees to only match subdirectory index files, and replacing a toctree directive with a :doc: cross-reference: - platforms/arm/index.rst: glob */* -> */index - platforms/index.rst: glob */* -> */index - guides/changing_systemclockconfig.rst: toctree -> :doc: ref Fixes #14785 Signed-off-by: hanzj --- Documentation/guides/changing_systemclockconfig.rst | 5 +---- Documentation/platforms/arm/goldfish/index.rst | 1 + Documentation/platforms/arm/index.rst | 3 ++- Documentation/platforms/index.rst | 3 ++- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/guides/changing_systemclockconfig.rst b/Documentation/guides/changing_systemclockconfig.rst index a6291c712a8..872415486eb 100644 --- a/Documentation/guides/changing_systemclockconfig.rst +++ b/Documentation/guides/changing_systemclockconfig.rst @@ -166,7 +166,4 @@ recalculate their frequency related settings. Here is some Power Management documentation: -.. toctree:: - :maxdepth: 1 - - /components/drivers/special/power/pm/index.rst \ No newline at end of file +- :doc:`/components/drivers/special/power/pm/index` diff --git a/Documentation/platforms/arm/goldfish/index.rst b/Documentation/platforms/arm/goldfish/index.rst index 727068db2f4..c01c1b84152 100644 --- a/Documentation/platforms/arm/goldfish/index.rst +++ b/Documentation/platforms/arm/goldfish/index.rst @@ -6,6 +6,7 @@ GOLDFISH :maxdepth: 1 goldfish_timer.rst + goldfish_sensor.rst Supported Boards ================ diff --git a/Documentation/platforms/arm/index.rst b/Documentation/platforms/arm/index.rst index bb7d5421733..34c88f6864b 100644 --- a/Documentation/platforms/arm/index.rst +++ b/Documentation/platforms/arm/index.rst @@ -8,4 +8,5 @@ The following ARM SoC are supported: :maxdepth: 1 :glob: - */* + */index + diff --git a/Documentation/platforms/index.rst b/Documentation/platforms/index.rst index f88233a7205..370556a0e5a 100644 --- a/Documentation/platforms/index.rst +++ b/Documentation/platforms/index.rst @@ -12,4 +12,5 @@ series and boards supported in NuttX: :maxdepth: 3 :titlesonly: - */* + */index +