diff options
author | Linus Torvalds <torvalds@linux-foundation.org> | 2016-08-18 21:54:40 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2016-08-18 21:54:40 -0400 |
commit | 5cae6fe27a1dc4053ae2f8f52ef1ef2ca860bbfb (patch) | |
tree | dede384fddd9728847f54cdbb318545e6ea3835b | |
parent | 3408fef7448ce7d3c926978ee1a511e7707bffba (diff) | |
parent | d1669c8288a2c86daa6fd59c7fb938c08589d053 (diff) |
Merge tag '4.8-doc-fixes' of git://git.lwn.net/linux
Pull documentation fixes from Jonathan Corbet:
"Three small fixes for Sphinx-formatted documentation generation"
* tag '4.8-doc-fixes' of git://git.lwn.net/linux:
doc-rst: customize RTD theme, drop padding of inline literal
docs: kernel-documentation: remove some highlight directives
docs: Set the Sphinx default highlight language to "guess"
-rw-r--r-- | Documentation/conf.py | 2 | ||||
-rw-r--r-- | Documentation/kernel-documentation.rst | 6 | ||||
-rw-r--r-- | Documentation/sphinx-static/theme_overrides.css | 3 |
3 files changed, 3 insertions, 8 deletions
diff --git a/Documentation/conf.py b/Documentation/conf.py index 96b7aa66c89c..106ae9c740b9 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py | |||
@@ -131,7 +131,7 @@ pygments_style = 'sphinx' | |||
131 | todo_include_todos = False | 131 | todo_include_todos = False |
132 | 132 | ||
133 | primary_domain = 'C' | 133 | primary_domain = 'C' |
134 | highlight_language = 'C' | 134 | highlight_language = 'guess' |
135 | 135 | ||
136 | # -- Options for HTML output ---------------------------------------------- | 136 | # -- Options for HTML output ---------------------------------------------- |
137 | 137 | ||
diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst index c4eb5049da39..391decc66a18 100644 --- a/Documentation/kernel-documentation.rst +++ b/Documentation/kernel-documentation.rst | |||
@@ -366,8 +366,6 @@ Domain`_ references. | |||
366 | Cross-referencing from reStructuredText | 366 | Cross-referencing from reStructuredText |
367 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 367 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
368 | 368 | ||
369 | .. highlight:: none | ||
370 | |||
371 | To cross-reference the functions and types defined in the kernel-doc comments | 369 | To cross-reference the functions and types defined in the kernel-doc comments |
372 | from reStructuredText documents, please use the `Sphinx C Domain`_ | 370 | from reStructuredText documents, please use the `Sphinx C Domain`_ |
373 | references. For example:: | 371 | references. For example:: |
@@ -390,8 +388,6 @@ For further details, please refer to the `Sphinx C Domain`_ documentation. | |||
390 | Function documentation | 388 | Function documentation |
391 | ---------------------- | 389 | ---------------------- |
392 | 390 | ||
393 | .. highlight:: c | ||
394 | |||
395 | The general format of a function and function-like macro kernel-doc comment is:: | 391 | The general format of a function and function-like macro kernel-doc comment is:: |
396 | 392 | ||
397 | /** | 393 | /** |
@@ -572,8 +568,6 @@ DocBook XML [DEPRECATED] | |||
572 | Converting DocBook to Sphinx | 568 | Converting DocBook to Sphinx |
573 | ---------------------------- | 569 | ---------------------------- |
574 | 570 | ||
575 | .. highlight:: none | ||
576 | |||
577 | Over time, we expect all of the documents under ``Documentation/DocBook`` to be | 571 | Over time, we expect all of the documents under ``Documentation/DocBook`` to be |
578 | converted to Sphinx and reStructuredText. For most DocBook XML documents, a good | 572 | converted to Sphinx and reStructuredText. For most DocBook XML documents, a good |
579 | enough solution is to use the simple ``Documentation/sphinx/tmplcvt`` script, | 573 | enough solution is to use the simple ``Documentation/sphinx/tmplcvt`` script, |
diff --git a/Documentation/sphinx-static/theme_overrides.css b/Documentation/sphinx-static/theme_overrides.css index 3a2ac4bcfd78..e88461c4c1e6 100644 --- a/Documentation/sphinx-static/theme_overrides.css +++ b/Documentation/sphinx-static/theme_overrides.css | |||
@@ -42,11 +42,12 @@ | |||
42 | caption a.headerlink { opacity: 0; } | 42 | caption a.headerlink { opacity: 0; } |
43 | caption a.headerlink:hover { opacity: 1; } | 43 | caption a.headerlink:hover { opacity: 1; } |
44 | 44 | ||
45 | /* inline literal: drop the borderbox and red color */ | 45 | /* inline literal: drop the borderbox, padding and red color */ |
46 | 46 | ||
47 | code, .rst-content tt, .rst-content code { | 47 | code, .rst-content tt, .rst-content code { |
48 | color: inherit; | 48 | color: inherit; |
49 | border: none; | 49 | border: none; |
50 | padding: unset; | ||
50 | background: inherit; | 51 | background: inherit; |
51 | font-size: 85%; | 52 | font-size: 85%; |
52 | } | 53 | } |