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"

Linus Torvalds committed 10 years ago

Commit 5cae6fe2 parents 3408fef d1669c83 files · +3 −8Browse files

Unified · Split

3 files

Documentation/conf.py +1 −1
Documentation/kernel-documentation.rst +0 −6
Documentation/sphinx-static/theme_overrides.css +2 −1

Documentation/conf.py+1−1

@@ -131,7 +131,7 @@ pygments_style = 'sphinx' · 130 unmodified lines
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

Documentation/kernel-documentation.rst+0−6

@@ -366,8 +366,6 @@ Domain`_ references. · 365 unmodified lines
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. · 16 unmodified lines
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] · 174 unmodified lines
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,

Documentation/sphinx-static/theme_overrides.css+2−1

     caption a.headerlink { opacity: 0; }
     caption a.headerlink:hover { opacity: 1; }
-    /* inline literal: drop the borderbox and red color */
+    /* inline literal: drop the borderbox, padding and red color */
     code, .rst-content tt, .rst-content code {
         color: inherit;
         border: none;
+        padding: unset;
         background: inherit;
         font-size: 85%;
     }