summaryrefslogtreecommitdiff
path: root/Documentation/mainboard
diff options
context:
space:
mode:
authorNicholas Chin <nic.c3.14@gmail.com>2024-09-06 22:09:29 -0600
committerFelix Singer <service+coreboot-gerrit@felixsinger.de>2024-10-27 23:50:29 +0000
commit10d22313f70593c5ea8965aceb7cf5e862ad5221 (patch)
tree100cf5a14403edda2bc62e9d3988dda7795c7fa6 /Documentation/mainboard
parent84088853d7e2fd6e8d1de21f8bca34dbf41c4462 (diff)
Docs: Address remaining documents not included in toctrees
Sphinx outputs "document isn't included in any toctree" warnings for a few files in the Documentation tree, so address this by adding them to toctrees or explicitly marking them as excluded. - mb/starlabs/common/building.md: Add to the Star Labs toctree in mainboard/index.md - RFC/intel-gpio-cleanup.md: Mark as orphan to explicitly exclude it from the docs. - drivers/dt_entries.md: This was already accessible through an inline link in drivers/index.md, but links do not add items to toctrees. Add a hidden toctree listing dt_entries.md to define its heirarchy in the documentation while preserving the inline link instead of moving the link to a single item list like a normal toctree would. The content of this document did not fit the existing toctree in drivers/index.md, which appears to list drivers, while dt_entries discusses connecting those drivers to the devicetree. Change-Id: I5fd6851a3adf6c91d81298fc61f773dae6eeca19 Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/84245 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
Diffstat (limited to 'Documentation/mainboard')
-rw-r--r--Documentation/mainboard/index.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/Documentation/mainboard/index.md b/Documentation/mainboard/index.md
index 259a2b2e4b..3cae8f18fb 100644
--- a/Documentation/mainboard/index.md
+++ b/Documentation/mainboard/index.md
@@ -336,6 +336,7 @@ StarBook Mk VI <starlabs/starbook_adl.md>
Byte Mk II <starlabs/byte_adl.md>
StarFighter Mk I <starlabs/starfighter_rpl.md>
+Building coreboot <starlabs/common/building.md>
Flashing devices <starlabs/common/flashing.md>
```