Skip to content

Conversation

kartben
Copy link
Contributor

@kartben kartben commented Oct 9, 2025

  • Removed some intermediate index page that were unnecessary and causing some boards to appear in multiple toctrees
  • Made the documentation common "snippets" non .rst files so that they don't incorrectly end up in the global documentation toctree (and then incorrectly show up here)

https://builds.zephyrproject.io/zephyr/pr/97302/docs/

This intermediate index page is unnecessary and causes the boards that
are included in its toctree to appear in multiple toctrees, which is a
Sphinx warning.

Signed-off-by: Benjamin Cabé <[email protected]>
This intermediate index page is unnecessary and causes the boards that
are included in its toctree to appear in multiple toctrees, which is a
Sphinx warning.

Signed-off-by: Benjamin Cabé <[email protected]>
@kartben kartben force-pushed the nxp_doc branch 2 times, most recently from d651c47 to ca53baa Compare October 9, 2025 20:42
Ensure that common documentation snippets meant to be "literalinclude"d
in other pages are not treated as regular rst files and de facto
excluded from the documentation global toctree.

Signed-off-by: Benjamin Cabé <[email protected]>
@kartben kartben changed the title doc: boards: nxp: frdm_mcxaxx6: remove unnecessary index page doc: boards: nxp: Multiple (trivial) fixes to NXP boards/shields docs Oct 9, 2025
@kartben kartben requested a review from DerekSnell October 9, 2025 21:01
@kartben kartben marked this pull request as ready for review October 9, 2025 21:06
Copy link

sonarqubecloud bot commented Oct 9, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants