From 10d22313f70593c5ea8965aceb7cf5e862ad5221 Mon Sep 17 00:00:00 2001
From: Nicholas Chin <nic.c3.14@gmail.com>
Date: Fri, 6 Sep 2024 22:09:29 -0600
Subject: [PATCH] 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>
---
 Documentation/RFC/intel-gpio-cleanup.md | 4 ++++
 Documentation/drivers/index.md          | 7 +++++++
 Documentation/mainboard/index.md        | 1 +
 3 files changed, 12 insertions(+)

diff --git a/Documentation/RFC/intel-gpio-cleanup.md b/Documentation/RFC/intel-gpio-cleanup.md
index b509fddcd0..576db1e2e9 100644
--- a/Documentation/RFC/intel-gpio-cleanup.md
+++ b/Documentation/RFC/intel-gpio-cleanup.md
@@ -1,3 +1,7 @@
+```{eval-rst}
+:orphan:
+```
+
 # Background
 
 CB:31250 ("soc/intel/cannonlake: Configure GPIOs again after FSP-S is
diff --git a/Documentation/drivers/index.md b/Documentation/drivers/index.md
index 9b7d25ca23..efbc186e75 100644
--- a/Documentation/drivers/index.md
+++ b/Documentation/drivers/index.md
@@ -6,6 +6,13 @@ they allow to easily reuse existing code across platforms.
 
 For details on how to connect device drivers to a mainboard, see [Driver Devicetree Entries](dt_entries.md).
 
+```{toctree}
+:maxdepth: 1
+:hidden:
+
+Driver Devicetree Entries <dt_entries.md>
+```
+
 Some of the drivers currently available include:
 
 ```{toctree}
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>
 ```
 
-- 
2.11.4.GIT