[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.

As a follow-up, please update .gitlab-ci.yml at least to include a run
of "make htmldocs".  If we need to update the Dockerfile to include new
utils we can do that too, 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/f95de78a/attachment.sig>