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

Bin Meng bmeng.cn at gmail.com
Wed Jul 24 04:53:17 UTC 2019


Hi Wolfgang,

On Tue, Jul 23, 2019 at 11:01 PM Wolfgang Denk <wd at denx.de> wrote:
>
> Dear Bin,
>
> In message <CAEUhbmVBz0z+Dh_q1hJKDOuoiJ1ZJ025hiLrYFUwDbp0UrxD1g at mail.gmail.com> you wrote:
> >
> > > @Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?
> > >
> > > This series is available at u-boot-x86/doc for testing.
> > >
> >
> > Ping?
>
> Yes, this is possible.  Where can I find the HTML files?  And where

The HTML files can be generated from the U-Boot source tree by "make htmldocs".

> would you want to put them?  And what is the planned update
> strategy?

If possible, can we have denx.de or gitlab.denx.de host the generated HTML docs?

>
> I mean, plain HTML documents are a bit lame, as they refer to a
> specific version of U-Boot only.  What if I want to see the docs for
> a version of half a year ago?
>
> What exactly are your plans?

For versioned HTML, let's take a look at how Linux kernel does:
https://www.kernel.org/doc/html/

I think we can imitate Linux by having released doc archive (generated
for each release), latest doc which is nightly built that always
points to latest htmldocs in the tree. Maybe we can have additional
-rc release doc for current release (eg: v2019.10-rc1), and these -rc
htmldocs will get cleaned up when the official release is out.
Thoughts?

Regards,
Bin


More information about the U-Boot mailing list