Zepp-Hanzj opened a new pull request, #19027:
URL: https://github.com/apache/nuttx/pull/19027

   ## Summary
   
   Fix Sphinx documentation build warnings caused by documents referenced in 
multiple toctrees.
   
   Fixes #14785
   
   ## Problem
   
   Several `.rst` files are referenced by both a parent toctree (via glob 
pattern) and a child toctree (explicit entry), causing Sphinx warnings:
   
   ```
   document is referenced in multiple toctrees: [...], selecting: [...]
   ```
   
   Affected files:
   - `components/drivers/special/power/pm/index.rst`
   - `platforms/arm/goldfish/goldfish_timer.rst`
   - `platforms/arm/nrf52/ieee802154.rst`
   - `platforms/sim/network_linux.rst`
   - `platforms/sim/network_vpnkit.rst`
   
   ## Fix
   
   1. **`platforms/arm/index.rst`**: Narrow glob pattern from `*/*` to 
`*/index` — only match subdirectory index files, not their children.
   
   2. **`platforms/index.rst`**: Same glob narrowing from `*/*` to `*/index`.
   
   3. **`guides/changing_systemclockconfig.rst`**: Replace `.. toctree::` 
directive with `:doc:` cross-reference, since this is a guide page that links 
to PM docs, not a structural parent.
   
   These are the only non-index `.rst` files at the affected directory levels, 
so the narrowed globs remain functionally equivalent while eliminating the 
duplicate references.
   
   ## Testing
   
   Verified that no other non-index `.rst` files exist at the affected 
directory levels that would be missed by the narrowed glob patterns.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to