[PATCH v2 1/2] doc: add generated index to table of contents

Heinrich Schuchardt heinrich.schuchardt at canonical.com
Sun Jan 14 19:58:43 CET 2024


Show the index in the navigation sidebar.

doc/genindex.rst is needed to create the navigation sidebar entry.
output/genindex.html will only contain the generated content.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
---
v2:
	Provide doc/genindex.rst
---
 doc/genindex.rst | 4 ++++
 doc/index.rst    | 5 ++++-
 2 files changed, 8 insertions(+), 1 deletion(-)
 create mode 100644 doc/genindex.rst

diff --git a/doc/genindex.rst b/doc/genindex.rst
new file mode 100644
index 0000000000..2e452cb8f5
--- /dev/null
+++ b/doc/genindex.rst
@@ -0,0 +1,4 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Index
+=====
diff --git a/doc/index.rst b/doc/index.rst
index 57b42c68e4..43398627d8 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -99,4 +99,7 @@ Chromium OS-specific doc
 Indices and tables
 ==================
 
-* :ref:`genindex`
+.. toctree::
+   :maxdepth: 1
+
+   genindex
-- 
2.43.0



More information about the U-Boot mailing list