u-boot/doc/index.rst

.. SPDX-License-Identifier: GPL-2.0+

#######################
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

   api/index
doc: add structure to Sphinx generated docs Create separate html pages for linker lists, the serial subsystem, and the EFI subsystem. Add a table of content. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2018-07-29 19:45:47 +08:00			`.. SPDX-License-Identifier: GPL-2.0+`
doc: Replace DocBook with sphinx-based docs The Linux kernel moved to sphinx-based documentation and got rid of the DocBook based documentation quite a while ago. Hence, the DocBook documentation for U-Boot should be converted as well. To achieve this, import the necessary files from Linux v4.17, and convert the current DocBook documentation (three files altogether) to sphinx/reStructuredText. For now, all old DocBook documentation was merged into a single handbook, tentatively named "U-Boot Hacker Manual". For some source files, the documentation style was changed to comply with kernel-doc; no functional changes were applied. Signed-off-by: Mario Six <mario.six@gdsys.cc> 2018-07-10 14:40:17 +08:00
doc: add structure to Sphinx generated docs Create separate html pages for linker lists, the serial subsystem, and the EFI subsystem. Add a table of content. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2018-07-29 19:45:47 +08:00			`#######################`
			`U-Boot Developer Manual`
			`#######################`
doc: Replace DocBook with sphinx-based docs The Linux kernel moved to sphinx-based documentation and got rid of the DocBook based documentation quite a while ago. Hence, the DocBook documentation for U-Boot should be converted as well. To achieve this, import the necessary files from Linux v4.17, and convert the current DocBook documentation (three files altogether) to sphinx/reStructuredText. For now, all old DocBook documentation was merged into a single handbook, tentatively named "U-Boot Hacker Manual". For some source files, the documentation style was changed to comply with kernel-doc; no functional changes were applied. Signed-off-by: Mario Six <mario.six@gdsys.cc> 2018-07-10 14:40:17 +08:00
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> 2019-07-18 15:33:46 +08:00			`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).`

doc: add structure to Sphinx generated docs Create separate html pages for linker lists, the serial subsystem, and the EFI subsystem. Add a table of content. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2018-07-29 19:45:47 +08:00			`.. toctree::`
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> 2019-07-18 15:33:46 +08:00			`:maxdepth: 2`
doc: Replace DocBook with sphinx-based docs The Linux kernel moved to sphinx-based documentation and got rid of the DocBook based documentation quite a while ago. Hence, the DocBook documentation for U-Boot should be converted as well. To achieve this, import the necessary files from Linux v4.17, and convert the current DocBook documentation (three files altogether) to sphinx/reStructuredText. For now, all old DocBook documentation was merged into a single handbook, tentatively named "U-Boot Hacker Manual". For some source files, the documentation style was changed to comply with kernel-doc; no functional changes were applied. Signed-off-by: Mario Six <mario.six@gdsys.cc> 2018-07-10 14:40:17 +08:00
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> 2019-07-18 15:33:46 +08:00			`api/index`