Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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"
+3
-8
+1
-1
Documentation/conf.py
+1
-1
Documentation/conf.py
-6
Documentation/kernel-documentation.rst
-6
Documentation/kernel-documentation.rst
···
366
366
Cross-referencing from reStructuredText
367
367
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
368
368
369
-
.. highlight:: none
370
-
371
369
To cross-reference the functions and types defined in the kernel-doc comments
372
370
from reStructuredText documents, please use the `Sphinx C Domain`_
373
371
references. For example::
···
387
389
388
390
Function documentation
389
391
----------------------
390
-
391
-
.. highlight:: c
392
392
393
393
The general format of a function and function-like macro kernel-doc comment is::
394
394
···
567
571
568
572
Converting DocBook to Sphinx
569
573
----------------------------
570
-
571
-
.. highlight:: none
572
574
573
575
Over time, we expect all of the documents under ``Documentation/DocBook`` to be
574
576
converted to Sphinx and reStructuredText. For most DocBook XML documents, a good
+2
-1
Documentation/sphinx-static/theme_overrides.css
+2
-1
Documentation/sphinx-static/theme_overrides.css
···
42
42
caption a.headerlink { opacity: 0; }
43
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
47
code, .rst-content tt, .rst-content code {
48
48
color: inherit;
49
49
border: none;
50
+
padding: unset;
50
51
background: inherit;
51
52
font-size: 85%;
52
53
}