[PATCH v2 4/4] doc: update Kernel documentation build system

Bin Meng bmeng.cn at gmail.com
Sat Feb 6 00:57:29 CET 2021


On Fri, Feb 5, 2021 at 10:43 PM Simon Glass <sjg at chromium.org> wrote:
>
> Hi Heinrich,
>
> On Mon, 1 Feb 2021 at 13:39, Simon Glass <sjg at chromium.org> wrote:
> >
> > On Tue, 26 Jan 2021 at 11:36, Heinrich Schuchardt <xypron.glpk at gmx.de> wrote:
> > >
> > > Update the documentation build system according to Linux v5.11-rc1.
> > >
> > > Deactive the automarkup.py extension module which on Gitlab CI is
> > > incompatible with Unicode.
> > >
> > > With this patch we can build the HTML documentation using either of
> > > Sphinx 2 and Sphinx 3.
> > >
> > > Signed-off-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
> > > ---
> > > v2:
> > >         Deactive the automarkup.py extension module
> > > ---
> > >  doc/conf.py                       | 141 ++++++++--
> > >  doc/sphinx/automarkup.py          | 290 +++++++++++++++++++
> > >  doc/sphinx/cdomain.py             |  93 +++++-
> > >  doc/sphinx/kernel_abi.py          | 194 +++++++++++++
> > >  doc/sphinx/kernel_feat.py         | 169 +++++++++++
> > >  doc/sphinx/kerneldoc.py           |  15 +-
> > >  doc/sphinx/kernellog.py           |   6 +-
> > >  doc/sphinx/kfigure.py             |   6 +-
> > >  doc/sphinx/load_config.py         |  27 +-
> > >  doc/sphinx/maintainers_include.py | 197 +++++++++++++
> > >  doc/sphinx/parallel-wrapper.sh    |  33 +++
> > >  doc/sphinx/parse-headers.pl       |   6 +-
> > >  doc/sphinx/requirements.txt       |   5 +-
> > >  scripts/kernel-doc                | 450 ++++++++++++++++++++++--------
> > >  14 files changed, 1476 insertions(+), 156 deletions(-)
> > >  create mode 100644 doc/sphinx/automarkup.py
> > >  create mode 100644 doc/sphinx/kernel_abi.py
> > >  create mode 100644 doc/sphinx/kernel_feat.py
> > >  create mode 100755 doc/sphinx/maintainers_include.py
> > >  create mode 100644 doc/sphinx/parallel-wrapper.sh
> >
> > Reviewed-by: Simon Glass <sjg at chromium.org>
>
> I notice that on u-boot.readthedocs.io latest it shows The Linux
> Kernel for the docs...I can't see how but I guess this patch help with
> that?

Yep, I reported this to Heinrich before:
https://lists.denx.de/pipermail/u-boot/2021-February/439615.html

Regards,
Bin


More information about the U-Boot mailing list