Skip to content

Address several issues when building media docs with Sphinx 3.x

Mauro Carvalho Chehab linux-media lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest9 patches 1 replyIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/9media: camera-sensor.rst: fix a doc build warningDocumentation/driver-api/media/camera-sensor.rst+1 -10 replies
2/9media: glossary.rst: use the right case for glossary entriesDocumentation/userspace-api/media/glossary.rst+10 -100 replies
3/9media: docs: ipu3.rst: rely at automarkup extensionDocumentation/admin-guide/media/ipu3.rst+19 -191 reply
4/9media: dvb-frontends: remove a clone of a kernel-doc markup at zd1301_demod.hdrivers/media/dvb-frontends/zd1301_demod.h+0 -60 replies
5/9media: v4l2-subdev.rst: get rid of a duplicatd kernel-doc markupDocumentation/driver-api/media/v4l2-subdev.rst+0 -20 replies
6/9media: cec-core.rst: fix warnings with Sphinx 3.0+Documentation/driver-api/media/cec-core.rst+26 -360 replies
7/9media: v4l2-subdev.h: fix a kernel-doc markupinclude/media/v4l2-subdev.h+1 -10 replies
8/9media: hist-v4l2.rst: remove struct duplicationDocumentation/userspace-api/media/v4l/hist-v4l2.rst+5 -70 replies
9/9media: hist-v4l2.rst: remove :c:`type` from structs and enumsDocumentation/userspace-api/media/v4l/hist-v4l2.rst+101 -1280 replies

Reviews trailers per patch

1 of 9 patches has a Reviewed-by or Acked-by.

PatchSakari Ailus
1/9
2/9
3/9A-b
4/9
5/9
6/9
7/9
8/9
9/9

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH 0/9] Address several issues when building media docs with Sphinx 3.x

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(-)
Signature · 1 line
2.26.2