doc: Move existing rst files into api sub-directory

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@gmail.com>
Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
This commit is contained in:
Bin Meng 2019-07-18 00:33:46 -07:00 committed by Tom Rini
parent fe4243870d
commit c8fe916c91
5 changed files with 23 additions and 4 deletions

11
doc/api/index.rst Normal file
View File

@ -0,0 +1,11 @@
.. SPDX-License-Identifier: GPL-2.0+
U-Boot API documentation
========================
.. toctree::
:maxdepth: 2
efi
linker_lists
serial

View File

@ -4,8 +4,16 @@
U-Boot Developer Manual
#######################
.. toctree::
U-Boot API documentation
------------------------
efi
linker_lists
serial
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
api/index