docs: conf.py: avoid thousands of duplicate label warning on Sphinx
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Fri, 20 Mar 2020 15:11:03 +0000 (16:11 +0100)
committerJonathan Corbet <corbet@lwn.net>
Fri, 20 Mar 2020 23:01:34 +0000 (17:01 -0600)
commit4658b0eb9430e2c228a0a9cc6e66f0b90d3853e1
tree8385fa327e4ea5b41663e091eae1a964be9dd9f6
parentc44166fe5f38f0559eff1138cca094f3460e2345
docs: conf.py: avoid thousands of duplicate label warning on Sphinx

The autosectionlabel extension is nice, as it allows to refer to
a section by its name without requiring any extra tag to create
a reference name.

However, on its default, it has two serious problems:

1) the namespace is global. So, two files with different
   "introduction" section would create a label with the
   same name. This is easily solvable by forcing the extension
   to prepend the file name with:

autosectionlabel_prefix_document = True

2) It doesn't work hierarchically. So, if there are two level 1
   sessions (let's say, one labeled "open" and another one "ioctl")
   and both have a level 2 "synopsis" label, both section 2 will
   have the same identical name.

   Currently, there's no way to tell Sphinx to create an
   hierarchical reference like:

open / synopsis
ioctl / synopsis

  This causes around 800 warnings. So, the fix should be to
  not let autosectionlabel to produce references for anything
  that it is not at a chapter level within any doc, with:

autosectionlabel_maxdepth = 2

Fixes: 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/74f4d8d91c648d7101c45b4b99cc93532f4dadc6.1584716446.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/conf.py