From: Tom Rini Date: Wed, 24 Jul 2019 10:18:00 -0400 Subject: [U-Boot] [PATCH 00/50] doc: Shape into useful HTML docs In-Reply-To: References: <1563435275-22326-1-git-send-email-bmeng.cn@gmail.com> <20190724141419.GC20116@bill-the-cat> Message-ID: <20190724141800.GD20116@bill-the-cat> List-Id: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: u-boot@lists.denx.de On Wed, Jul 24, 2019 at 10:16:31PM +0800, Bin Meng wrote: > Hi Tom, > > On Wed, Jul 24, 2019 at 10:14 PM Tom Rini wrote: > > > > 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 /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! > > 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. -- Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 819 bytes Desc: not available URL: