[U-Boot] [PATCH 00/50] doc: Shape into useful HTML docs

[Tom Rini]

On Thu, Jul 18, 2019 at 12:33:45AM -0700, Bin Meng wrote:

> At present there is Sphinx doc build system in U-Boot, however the
> contents are very limited, e.g.: only a few API descriptions like
> 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.
> 
> With this series, now we have the following major chapters in our
> U-Boot HTML doc:
> 
> - Driver Model
> - U-Boot API documentation
> - Architecture-specific doc
> - Board-specific doc
> 
> Board specific documents are put in a vendor subdirectory, just like
> what we have in <src_tree>/board. All x86 & RISC-V board docs are
> converted to reST. A few other board docs are converted too.
> 
> Tested by generating the HTML docs, 0 build warnings.
> 
> This patch is rebased on https://patchwork.ozlabs.org/patch/1131726/.
> 
> @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 (50):
>   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: driver-model: Convert fdt-fixup.txt to reST
>   doc: driver-model: Convert fs_firmware_loader.txt to reST
>   doc: driver-model: Convert i2c-howto.txt to reST
>   doc: driver-model: Convert livetree.txt to reST
>   doc: driver-model: Convert of-plat.txt to reST
>   doc: driver-model: Convert pci-info.txt to reST
>   doc: driver-model: Convert pmic-framework.txt to reST
>   doc: driver-model: Convert remoteproc-framework.txt to reST
>   doc: driver-model: Convert serial-howto.txt to reST
>   doc: driver-model: Convert spi-howto.txt to reST
>   doc: driver-model: Convert usb-info.txt to reST
>   doc: Add architecture specific info to Sphinx TOC tree
>   doc: arch: Convert README.mips to reST
>   doc: Add board specific info to Sphinx TOC tree
>   doc: board: Add Intel Crown Bay board doc
>   doc: board: Add Intel Bay Trail based board docs
>   doc: board: Add Intel Cherry Hill board doc
>   doc: board: Add Intel Cougar Canyon 2 board doc
>   doc: board: Add Intel Edison board doc
>   doc: board: Add Intel Galileo board doc
>   doc: board: Add Google Chromebook Link board doc
>   doc: board: Add Google Chromebook Samus board doc
>   doc: board: Add coreboot board doc
>   doc: board: Add QEMU x86 board doc
>   doc: board: Convert README.qemu-arm to reST
>   doc: board: Convert README.qemu-riscv to reST
>   doc: board: Convert README.qemu-mips to reST
>   doc: board: Add AndesTech ax25-ae350 board doc
>   doc: board: Convert README.ag101p to reST
>   doc: board: Convert README.sifive-fu540 to reST
>   doc: board: Convert README.sh7752evb to reST
>   doc: board: Convert README.sh7753evb to reST
>   doc: board: Convert README.at91 to reST
>   doc: board: Convert README.b4860qds to reST
>   doc: board: Convert README.zynq to reST
>   doc: arch: Convert README.x86 to reST
>   doc: arch: Convert README.arm64 to reST
>   doc: arch: Convert README.NDS32 to reST
>   doc: arch: Convert README.nios2 to reST
>   doc: arch: Convert README.ARC to reST
>   doc: arch: Convert README.m68k to reST
>   doc: arch: Convert README.sh to reST
>   doc: arch: Convert README.sandbox to reST
>   doc: arch: Convert README.xtensa to reST
>   doc: Remove README.blackfin

For the series, applied to u-boot/master, thanks!

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190724/9c4c28f4/attachment.sig>