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"
Unified · Split
| @@ -131,7 +131,7 @@ pygments_style = 'sphinx' · 130 unmodified lines | ||
| 131 | 131 | todo_include_todos = False |
| 132 | 132 | |
| 133 | 133 | primary_domain = 'C' |
| 134 | −highlight_language = 'C' | |
| 134 | +highlight_language = 'guess' | |
| 135 | 135 | |
| 136 | 136 | # -- Options for HTML output ---------------------------------------------- |
| 137 | 137 | |
| @@ -366,8 +366,6 @@ Domain`_ references. · 365 unmodified lines | ||
| 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:: |
| @@ -390,8 +388,6 @@ For further details, please refer to the `Sphinx C Domain`_ documentation. · 16 unmodified lines | ||
| 390 | 388 | Function documentation |
| 391 | 389 | ---------------------- |
| 392 | 390 | |
| 393 | −.. highlight:: c | |
| 394 | − | |
| 395 | 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 | 568 | Converting DocBook to Sphinx |
| 573 | 569 | ---------------------------- |
| 574 | 570 | |
| 575 | −.. highlight:: none | |
| 576 | − | |
| 577 | 571 | Over time, we expect all of the documents under ``Documentation/DocBook`` to be |
| 578 | 572 | converted to Sphinx and reStructuredText. For most DocBook XML documents, a good |
| 579 | 573 | enough solution is to use the simple ``Documentation/sphinx/tmplcvt`` script, |
| @@ -42,11 +42,12 @@ · 41 unmodified lines | ||
| 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 | } |