nuttx/Documentation/guides
hanzj 0916a88716 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>
2026-06-03 15:02:22 +08:00
..
image docs/guides/bootsequence: Migrate UML diagram to PlantUML 2026-02-15 08:47:23 +01:00
porting-case-studies include/debug.h: Move to include/nuttx/debug.h 2026-04-07 07:50:06 -03:00
armv7m_runtimestackcheck.rst style: Fix "the the" typo across the codebase. 2026-03-23 11:07:49 +01:00
automounter.rst
building_nuttx_with_app_out_of_src_tree.rst Doc: improve and add documentations for the guide section of the wiki 2024-12-30 12:32:42 +08:00
building_uclibcpp.rst Doc: improve and add documentations for the guide section of the wiki 2024-12-30 12:32:42 +08:00
changing_systemclockconfig.rst docs: Fix duplicate toctree references causing build warnings 2026-06-03 15:02:22 +08:00
cpp_cmake.rst Documentation/guides: Update CMake C++ guide 2025-09-15 15:30:15 -03:00
custom_app_directories.rst Doc: improve and add documentations for the guide section of the wiki 2024-12-30 12:32:42 +08:00
customapps.rst
customboards.rst Documentation/guides/customboards: add example minimal defconfig file 2026-02-28 20:59:01 -05:00
devicetree.rst
drivers.rst
etcromfs.rst Dockerfile & Docs: Change bitbucket.org/nuttx/tools to github.com 2026-05-25 08:34:45 -03:00
fortify.rst Doc: Fortify Instructions 2025-01-23 15:36:14 +08:00
fully_linked_elf.rst docs: Update the ELF guides 2025-06-11 23:11:08 +08:00
include_files_board_h.rst style: Fix "the the" typo across the codebase. 2026-03-23 11:07:49 +01:00
index.rst doc: update citests.rst and move to Testing 2026-01-04 09:40:12 -03:00
integrate_newlib.rst style: fix typos 2025-04-30 13:45:46 +08:00
ipv6.rst
kernel_threads_with_custom_stacks.rst sched/task: fix Redundant memory allocation. 2026-01-01 07:25:04 -03:00
logging_rambuffer.rst
lwl.rst docs/guides/lwl: move lwl's README.txt to lwl.rst 2025-12-23 15:20:06 +01:00
multiple_nsh_sessions.rst Doc: improve and add documentations for the guide section of the wiki 2024-12-30 12:32:42 +08:00
nestedinterrupts.rst
nfs.rst
nix_flake.rst tools/nix: move nix flakes to tools/ 2025-08-28 10:04:01 +08:00
nsh_network_link_management.rst Doc: improve and add documentations for the guide section of the wiki 2024-12-30 12:32:42 +08:00
ofloader.rst
optee.rst drivers/misc/optee: Expanded RPC support. 2025-08-06 02:29:33 +08:00
partially_linked_elf.rst docs: Update the ELF guides 2025-06-11 23:11:08 +08:00
platform_directories.rst style: fix typos 2025-04-30 13:45:46 +08:00
port.rst style: fix typos 2025-04-30 13:45:46 +08:00
port_bootsequence.rst docs/guides/bootsequence: Migrate UML diagram to PlantUML 2026-02-15 08:47:23 +01:00
port_drivers_to_stm32f7.rst Documentation: fix spelling 2025-05-15 11:33:41 +08:00
port_relatedkernelconfigrations.rst Documentation/guides: add the guide:how to port. 2024-12-12 21:52:24 +08:00
protected_build.rst !boards: Remove NSH_ARCHINIT and board_app_initialize 2026-05-02 18:36:46 +08:00
pysimcoder.rst Documentation: fix spelling 2025-05-15 11:33:41 +08:00
qemu_tips.rst Documentation: add notes about TAP configuration for qemu 2025-12-18 11:39:54 -03:00
ram_rom_disks.rst Doc: improve and add documentations for the guide section of the wiki 2024-12-30 12:32:42 +08:00
reading_can_msgs.rst nuttx/can: add message alignment 2025-11-24 14:11:41 +08:00
remove_device_drivers_nsh.rst Doc: improve and add documentations for the guide section of the wiki 2024-12-30 12:32:42 +08:00
renode.rst style: fix typos 2025-04-30 13:45:46 +08:00
rndis.rst style: fix typos 2025-04-30 13:45:46 +08:00
rust.rst !sched/clock: remove CONFIG_SYSTEM_TIME64 and always use 64-bit time 2026-05-19 16:21:28 +08:00
semihosting.rst doc: Add semihost syslog guide instructions 2025-10-24 09:56:24 +08:00
signal_events_interrupt_handlers.rst
signaling_sem_priority_inheritance.rst
simulator.rst Documentation: add nxmodbus doc 2026-04-21 09:39:04 +08:00
smaller_vector_tables.rst style: Fix "the the" typo across the codebase. 2026-03-23 11:07:49 +01:00
specialstuff_in_nuttxheaderfiles.rst
stm32ccm.rst style: Fix "the the" typo across the codebase. 2026-03-23 11:07:49 +01:00
stm32nullpointer.rst style: Fix "the the" typo across the codebase. 2026-03-23 11:07:49 +01:00
testingtcpip.rst
thread_local_storage.rst
updating_release_system_elf.rst Doc: improve and add documentations for the guide section of the wiki 2024-12-30 12:32:42 +08:00
usbtrace.rst !boards: Remove NSH_ARCHINIT and board_app_initialize 2026-05-02 18:36:46 +08:00
usingkernelthreads.rst Doc: Fix kernel thread API 2024-12-10 09:28:20 +08:00
versioning_and_task_names.rst Documentation/Make: add implementation/make_build_system.rst 2025-11-20 09:39:16 -05:00
zerolatencyinterrupts.rst Documentation: Tweak text about Zero Latency Interrupts 2024-12-11 01:27:48 +08:00