lkml.org 
[lkml]   [2020]   [Sep]   [30]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Subject[PATCH 0/9] Address several issues when building media docs with Sphinx 3.x
Date
The C domain parser was re-written on Sphinx 3.x.

It is now a lot more pedantic than on past versions, and has
specific macros for addressing C namespaces and documenting
data types, like c:struct, c:enum, c:macro, etc.

I'm currently working on addressing the issues upstream, as
some changes at the documentation build system are needed
(mainly kernel-doc and cdomain.py).

Yet, there are several simple issues at the media documentation
that can easily be fixed without requiring any changes at the
documentation build system.

While Sphinx < 3.x doesn't print any warnings, I suspect that
most issues addressed here will provide either duplicated
cross-references and/or produce wrong output.

This series address those.

As there's no change at the documentation content
(just format tags were changed), my plan is to apply this series
either later today or tomorrow.

Mauro Carvalho Chehab (9):
media: camera-sensor.rst: fix a doc build warning
media: glossary.rst: use the right case for glossary entries
media: docs: ipu3.rst: rely at automarkup extension
media: dvb-frontends: remove a clone of a kernel-doc markup at
zd1301_demod.h
media: v4l2-subdev.rst: get rid of a duplicatd kernel-doc markup
media: cec-core.rst: fix warnings with Sphinx 3.0+
media: v4l2-subdev.h: fix a kernel-doc markup
media: hist-v4l2.rst: remove struct duplication
media: hist-v4l2.rst: remove :c:`type` from structs and enums

Documentation/admin-guide/media/ipu3.rst | 38 +--
.../driver-api/media/camera-sensor.rst | 2 +-
Documentation/driver-api/media/cec-core.rst | 62 ++---
.../driver-api/media/v4l2-subdev.rst | 2 -
.../userspace-api/media/glossary.rst | 20 +-
.../userspace-api/media/v4l/hist-v4l2.rst | 239 ++++++++----------
drivers/media/dvb-frontends/zd1301_demod.h | 6 -
include/media/v4l2-subdev.h | 2 +-
8 files changed, 162 insertions(+), 209 deletions(-)

--
2.26.2


\
 
 \ /
  Last update: 2020-09-30 08:36    [W:0.080 / U:24.976 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site