• Mauro Carvalho Chehab's avatar
    docs: conf.py: avoid thousands of duplicate label warning on Sphinx · 4658b0eb
    Mauro Carvalho Chehab authored
    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: 58ad30cf ("docs: fix reference to core-api/namespaces.rst")
    Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
    Link: https://lore.kernel.org/r/74f4d8d91c648d7101c45b4b99cc93532f4dadc6.1584716446.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
    4658b0eb
conf.py 20.5 KB