[U-Boot] [RFC PATCH 0/9] Initial layout for Sphinx HTML docs

Bin Meng bmeng.cn at gmail.com
Tue Jul 16 16:42:45 UTC 2019


At present there is Sphinx doc build system in U-Boot, however the
contents are very limited, that only a few API descriptions for EFI,
are included.

This series proposes an initial Sphinx doc layout for future extension,
by converting some of the plain text documentation to reStructuredText
format and add it to Sphinx TOC tree.

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.


Bin Meng (9):
  doc: Move existing rst files into api sub-directory
  doc: Add top-level description about U-Boot documentation
  doc: Add driver-model to Sphinx TOC tree
  doc: driver-model: Convert README.txt to reST
  doc: driver-model: Convert MIGRATION.txt to reST
  doc: Add architecture specific info to Sphinx TOC tree
  doc: arch: Convert README.mips to reST
  doc: Add board to Sphinx TOC tree
  doc: board: Add Intel Crown Bay board doc

 doc/README.x86                                    |  37 --
 doc/{ => api}/efi.rst                             |   3 +
 doc/api/index.rst                                 |  10 +
 doc/{ => api}/linker_lists.rst                    |   3 +
 doc/{ => api}/serial.rst                          |   3 +
 doc/arch/index.rst                                |   8 +
 doc/{README.mips => arch/mips.rst}                |  14 +-
 doc/board/index.rst                               |   8 +
 doc/board/intel/crownbay.rst                      |  49 ++
 doc/board/intel/index.rst                         |   4 +
 doc/driver-model/{README.txt => design.rst}       | 538 ++++++++++++----------
 doc/driver-model/index.rst                        |   9 +
 doc/driver-model/{MIGRATION.txt => migration.rst} |  42 +-
 doc/index.rst                                     |  69 ++-
 14 files changed, 469 insertions(+), 328 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%)
 create mode 100644 doc/arch/index.rst
 rename doc/{README.mips => arch/mips.rst} (87%)
 create mode 100644 doc/board/index.rst
 create mode 100644 doc/board/intel/crownbay.rst
 create mode 100644 doc/board/intel/index.rst
 rename doc/driver-model/{README.txt => design.rst} (68%)
 create mode 100644 doc/driver-model/index.rst
 rename doc/driver-model/{MIGRATION.txt => migration.rst} (85%)

-- 
2.7.4



More information about the U-Boot mailing list