mirror of
https://github.com/apache/nuttx.git
synced 2026-10-17 19:18:55 +00:00
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 <hanzj@xiaomi.com>
This commit is contained in:
parent
e71e5e0a7c
commit
118bf9b52d
4 changed files with 6 additions and 6 deletions
|
|
@ -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
|
||||
- :doc:`/components/drivers/special/power/pm/index`
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ GOLDFISH
|
|||
:maxdepth: 1
|
||||
|
||||
goldfish_timer.rst
|
||||
goldfish_sensor.rst
|
||||
|
||||
Supported Boards
|
||||
================
|
||||
|
|
|
|||
|
|
@ -8,4 +8,5 @@ The following ARM SoC are supported:
|
|||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
*/*
|
||||
*/index
|
||||
|
||||
|
|
|
|||
|
|
@ -12,4 +12,5 @@ series and boards supported in NuttX:
|
|||
:maxdepth: 3
|
||||
:titlesonly:
|
||||
|
||||
*/*
|
||||
*/index
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue