mirror of
				git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
				synced 2025-10-31 08:44:41 +00:00 
			
		
		
		
	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: 58ad30cf91 ("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>
			
			
This commit is contained in:
		
							parent
							
								
									c44166fe5f
								
							
						
					
					
						commit
						4658b0eb94
					
				
					 1 changed files with 4 additions and 0 deletions
				
			
		|  | @ -40,6 +40,10 @@ extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain', | |||
|               'kfigure', 'sphinx.ext.ifconfig', 'automarkup', | ||||
|               'maintainers_include', 'sphinx.ext.autosectionlabel' ] | ||||
| 
 | ||||
| # Ensure that autosectionlabel will produce unique names | ||||
| autosectionlabel_prefix_document = True | ||||
| autosectionlabel_maxdepth = 2 | ||||
| 
 | ||||
| # The name of the math extension changed on Sphinx 1.4 | ||||
| if (major == 1 and minor > 3) or (major > 1): | ||||
|     extensions.append("sphinx.ext.imgmath") | ||||
|  |  | |||
		Loading…
	
	Add table
		
		Reference in a new issue
	
	 Mauro Carvalho Chehab
						Mauro Carvalho Chehab