Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 5cae6fe2 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

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"
parents 3408fef7 d1669c82

Documentation/conf.py

+1 −1
Original line number Original line Diff line number Diff line
@@ -131,7 +131,7 @@ pygments_style = 'sphinx' 
todo_include_todos = False

todo_include_todos = False





primary_domain = 'C'

primary_domain = 'C'

highlight_language = 'C'

highlight_language = 'guess'





# -- Options for HTML output ----------------------------------------------

# -- Options for HTML output ----------------------------------------------

Documentation/kernel-documentation.rst

+0 −6
Original line number Original line Diff line number Diff line
@@ -366,8 +366,6 @@ Domain`_ references. 
Cross-referencing from reStructuredText

Cross-referencing from reStructuredText

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~





.. highlight:: none



To cross-reference the functions and types defined in the kernel-doc comments

To cross-reference the functions and types defined in the kernel-doc comments

from reStructuredText documents, please use the `Sphinx C Domain`_

from reStructuredText documents, please use the `Sphinx C Domain`_

references. For example::

references. For example::
@@ -390,8 +388,6 @@ For further details, please refer to the `Sphinx C Domain`_ documentation. 
Function documentation

Function documentation

----------------------

----------------------





.. highlight:: c



The general format of a function and function-like macro kernel-doc comment is::

The general format of a function and function-like macro kernel-doc comment is::





  /**

  /**
@@ -572,8 +568,6 @@ DocBook XML [DEPRECATED] 
Converting DocBook to Sphinx

Converting DocBook to Sphinx

----------------------------

----------------------------





.. highlight:: none



Over time, we expect all of the documents under ``Documentation/DocBook`` to be

Over time, we expect all of the documents under ``Documentation/DocBook`` to be

converted to Sphinx and reStructuredText. For most DocBook XML documents, a good

converted to Sphinx and reStructuredText. For most DocBook XML documents, a good

enough solution is to use the simple ``Documentation/sphinx/tmplcvt`` script,

enough solution is to use the simple ``Documentation/sphinx/tmplcvt`` script,

Documentation/sphinx-static/theme_overrides.css

+2 −1
Original line number Original line Diff line number Diff line
@@ -42,11 +42,12 @@ 
    caption a.headerlink { opacity: 0; }

    caption a.headerlink { opacity: 0; }

    caption a.headerlink:hover { opacity: 1; }

    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 {

    code, .rst-content tt, .rst-content code {

        color: inherit;

        color: inherit;

        border: none;

        border: none;

        padding: unset;

        background: inherit;

        background: inherit;

        font-size: 85%;

        font-size: 85%;

    }

    }