u-boot/Documentation/index.rst

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

#######################
U-Boot Developer Manual
#######################

.. toctree::

   efi
   linker_lists
   serial
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 11:45:47 +00: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 06:40:17 +00: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 11:45:47 +00: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 06:40:17 +00: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 11:45:47 +00:00			`.. toctree::`
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 06:40:17 +00: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 11:45:47 +00:00			`efi`
			`linker_lists`
			`serial`