[U-Boot] [RFC PATCH 1/9] doc: Move existing rst files into api sub-directory

[Bin Meng]

Currently the Sphinx doc only contains API descriptions of several
U-Boot subsystems. For future extension, group these existing docs
into an API sub-directory.

Signed-off-by: Bin Meng <bmeng.cn at gmail.com>
---

 doc/{ => api}/efi.rst          |  3 +++
 doc/api/index.rst              | 10 ++++++++++
 doc/{ => api}/linker_lists.rst |  3 +++
 doc/{ => api}/serial.rst       |  3 +++
 doc/index.rst                  | 14 +++++++++++---
 5 files changed, 30 insertions(+), 3 deletions(-)
 rename doc/{ => api}/efi.rst (92%)
 create mode 100644 doc/api/index.rst
 rename doc/{ => api}/linker_lists.rst (99%)
 rename doc/{ => api}/serial.rst (80%)

diff --git a/doc/efi.rst b/doc/api/efi.rst
similarity index 92%
rename from doc/efi.rst
rename to doc/api/efi.rst
index 5337a55..3b2d544 100644
--- a/doc/efi.rst
+++ b/doc/api/efi.rst
@@ -1,5 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0+
 
+.. toctree::
+   :maxdepth: 2
+
 EFI subsystem
 =============
 
diff --git a/doc/api/index.rst b/doc/api/index.rst
new file mode 100644
index 0000000..8e1e1a1
--- /dev/null
+++ b/doc/api/index.rst
@@ -0,0 +1,10 @@
+========================
+U-Boot API documentation
+========================
+
+.. toctree::
+   :maxdepth: 2
+
+   efi
+   linker_lists
+   serial
diff --git a/doc/linker_lists.rst b/doc/api/linker_lists.rst
similarity index 99%
rename from doc/linker_lists.rst
rename to doc/api/linker_lists.rst
index 72f514e..477bbae 100644
--- a/doc/linker_lists.rst
+++ b/doc/api/linker_lists.rst
@@ -1,5 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0+
 
+.. toctree::
+   :maxdepth: 2
+
 Linker-Generated Arrays
 =======================
 
diff --git a/doc/serial.rst b/doc/api/serial.rst
similarity index 80%
rename from doc/serial.rst
rename to doc/api/serial.rst
index ed34e59..65f10d3 100644
--- a/doc/serial.rst
+++ b/doc/api/serial.rst
@@ -1,5 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0+
 
+.. toctree::
+   :maxdepth: 2
+
 Serial system
 =============
 
diff --git a/doc/index.rst b/doc/index.rst
index 0353c10..1946d09 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -4,8 +4,16 @@
 U-Boot Developer Manual
 #######################
 
+U-Boot API documentation
+------------------------
+
+These books get into the details of how specific U-Boot subsystems work
+from the point of view of a U-Boot developer.  Much of the information here
+is taken directly from the U-Boot source, with supplemental material added
+as needed (or at least as we managed to add it - probably *not* all that is
+needed).
+
 .. toctree::
+   :maxdepth: 2
 
-   efi
-   linker_lists
-   serial
+   api/index
-- 
2.7.4