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

Heinrich Schuchardt xypron.glpk at gmx.de
Tue Jan 26 19:35:52 CET 2021


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.

Fix two non-conformant documents.

Heinrich Schuchardt (4):
  doc: board: fix Microchip MPFS Icicle Kit doc
  doc: fix doc/develop/logging.rst
  .gitlab-ci: install doc/sphinx/requirements.txt
  doc: update Kernel documentation build system

 .azure-pipelines.yml                |   6 +-
 .gitlab-ci.yml                      |   3 +
 doc/api/index.rst                   |   1 +
 doc/api/logging.rst                 |   6 +
 doc/board/microchip/mpfs_icicle.rst |  51 ++--
 doc/conf.py                         | 141 +++++++--
 doc/develop/logging.rst             |  13 +-
 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 +++++++++++++++++++++-------
 20 files changed, 1527 insertions(+), 185 deletions(-)
 create mode 100644 doc/api/logging.rst
 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

--
2.29.2



More information about the U-Boot mailing list