Skip to content

doc: Shape into useful HTML docs

Tom Rini u-boot 1 version New

Get series with b4
b4 am 20190724141419.GC20116@bill-the-cat

Versions newest first

  1. v1 Latest0 of 50 patches 0 repliesNew

Patches in v1 No applies recorded yet

None of the 50 patches the cover letter announces are in this archive.

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [U-Boot] [PATCH 00/50] doc: Shape into useful HTML docs
Quoted 34 lines · Bin Meng

Hi Tom,

Quoted 31 lines · Tom Rini
Quoted 27 lines · Bin Meng

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.

Quoted 7 lines
Quoted 3 lines

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!

Yes, but I will need some time to study GitLab's .gitlab-ci.yml :)

Could that be done later?

Yes, to be clear, I asked for a follow-up as I have this otherwise merged locally but can't test it since make htmldocs blows up about a lack of required tools that I don't see documented. Once my current pipeline finishes (of other changes) I'll push this.

Signature · 8 lines
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/54c57faf/attachment.sig>