History

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
  1. Documentation/conf.py +1 −1
  2. Documentation/kernel-documentation.rst +0 −6
  3. Documentation/sphinx-static/theme_overrides.css +2 −1
Documentation/conf.py+1−1
@@ -131,7 +131,7 @@ pygments_style = 'sphinx' · 130 unmodified lines
131131 todo_include_todos = False
132132
133133 primary_domain = 'C'
134−highlight_language = 'C'
134+highlight_language = 'guess'
135135
136136 # -- Options for HTML output ----------------------------------------------
137137
Documentation/kernel-documentation.rst+0−6
@@ -366,8 +366,6 @@ Domain`_ references. · 365 unmodified lines
366366 Cross-referencing from reStructuredText
367367 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
368368
369−.. highlight:: none
370−
371369 To cross-reference the functions and types defined in the kernel-doc comments
372370 from reStructuredText documents, please use the `Sphinx C Domain`_
373371 references. For example::
@@ -390,8 +388,6 @@ For further details, please refer to the `Sphinx C Domain`_ documentation. · 16 unmodified lines
390388 Function documentation
391389 ----------------------
392390
393−.. highlight:: c
394−
395391 The general format of a function and function-like macro kernel-doc comment is::
396392
397393 /**
@@ -572,8 +568,6 @@ DocBook XML [DEPRECATED] · 174 unmodified lines
572568 Converting DocBook to Sphinx
573569 ----------------------------
574570
575−.. highlight:: none
576−
577571 Over time, we expect all of the documents under ``Documentation/DocBook`` to be
578572 converted to Sphinx and reStructuredText. For most DocBook XML documents, a good
579573 enough solution is to use the simple ``Documentation/sphinx/tmplcvt`` script,
Documentation/sphinx-static/theme_overrides.css+2−1
@@ -42,11 +42,12 @@ · 41 unmodified lines
4242 caption a.headerlink { opacity: 0; }
4343 caption a.headerlink:hover { opacity: 1; }
4444
45− /* inline literal: drop the borderbox and red color */
45+ /* inline literal: drop the borderbox, padding and red color */
4646
4747 code, .rst-content tt, .rst-content code {
4848 color: inherit;
4949 border: none;
50+ padding: unset;
5051 background: inherit;
5152 font-size: 85%;
5253 }