Documentation/sphinx: fix primary_domain configuration
authorJohn Keeping <john@metanate.com>
Fri, 3 Mar 2017 12:24:05 +0000 (12:24 +0000)
committerJonathan Corbet <corbet@lwn.net>
Fri, 3 Mar 2017 23:12:30 +0000 (16:12 -0700)
With Sphinx 1.5.3 I get the warning:

WARNING: primary_domain 'C' not found, ignored.

It seems that domain names in Sphinx are case-sensitive and for the C
domain the name must be lower case.

Signed-off-by: John Keeping <john@metanate.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/conf.py

index f6823cf01275aa7f9fd48f7e623acf64b5a80016..7fadb3b8329343234d337c312807bf6c5bf543fa 100644 (file)
@@ -135,7 +135,7 @@ pygments_style = 'sphinx'
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
-primary_domain = 'C'
+primary_domain = 'c'
 highlight_language = 'none'
 
 # -- Options for HTML output ----------------------------------------------