Skip to content

Commit

Permalink
Merge tag '4.8-doc-fixes' of git://git.lwn.net/linux
Browse files Browse the repository at this point in the history
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"
  • Loading branch information
torvalds committed Aug 19, 2016
2 parents 3408fef + d1669c8 commit 5cae6fe
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Documentation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
todo_include_todos = False

primary_domain = 'C'
highlight_language = 'C'
highlight_language = 'guess'

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

Expand Down
6 changes: 0 additions & 6 deletions Documentation/kernel-documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -366,8 +366,6 @@ Domain`_ references.
Cross-referencing from reStructuredText
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. highlight:: none

To cross-reference the functions and types defined in the kernel-doc comments
from reStructuredText documents, please use the `Sphinx C Domain`_
references. For example::
Expand All @@ -390,8 +388,6 @@ For further details, please refer to the `Sphinx C Domain`_ documentation.
Function documentation
----------------------

.. highlight:: c

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

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

.. highlight:: none

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
enough solution is to use the simple ``Documentation/sphinx/tmplcvt`` script,
Expand Down
3 changes: 2 additions & 1 deletion Documentation/sphinx-static/theme_overrides.css
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,12 @@
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%;
}
Expand Down

0 comments on commit 5cae6fe

Please sign in to comment.