path: root/Documentation/sphinx-static
AgeCommit message (Collapse)Author
2019-10-02doc-rst: Reduce CSS padding around FieldKees Cook
Right now any ":Field Name: Field Contents" lines end up with significant padding due to CSS from the "table" CSS which rightly needs padding to make tables readable. However, field lists don't need this as they tend to be stacked together. The future heavy use of fields in the parsed MAINTAINERS file needs this cleaned up, and existing users look better too. Note the needless white space (and misalignment of name/contents) between "Date" and "Author": This patch fixes this by lowering the padding with a more specific CSS. Signed-off-by: Kees Cook <> Signed-off-by: Jonathan Corbet <>
2018-10-07docs: improve readability for people with poorer eyesightDarrick J. Wong
My eyesight is not in good shape, which means that I have difficulty reading the online Linux documentation. Specifically, body text is oddly small compared to list items and the contrast of various text elements is too low for me to be able to see easily. Therefore, alter the HTML theme overrides to make the text larger and increase the contrast for better visibility, and trust the typeface choices of the reader's browser. For the PDF output, increase the text size, use a sans-serif typeface for sans-serif text, and use a serif typeface for "roman" serif text. Signed-off-by: Darrick J. Wong <> Acked-by: Dave Chinner <> Signed-off-by: Jonathan Corbet <>
2017-07-17docs RTD theme: code-block with line nos - lines and line numbers don't line up.Markus Heiser
In a code-block with line numbers (option :lineno:) there is a misalignment of the rendered source code lines on the right side and the line numbers on the left side. Since this issue is reported to the RTD theme project, it might be fixed in the future (take this as a interim solution). Signed-off-by: Markus Heiser <> Signed-off-by: Jonathan Corbet <>
2017-07-17docs RDT theme: fix bottom margin of lists itemsMarkus Heiser
List items with two ore more blocks are not well rendered. E.g. the gap between last block (l1-b2) of the first list item and the following list item (L2) is to small:: * L1 xxxxxxxxxx xxxxxxxxxxxxx l1-b2 xxxxxxx xxxxxxxxxxxxx * L2 xxxxxxxxxx xxxxxxxxxxxxx So that it can be read more liquidly, a distance was added to the last block (l1-b2):: * L1 xxxxxxxxxx xxxxxxxxxxxxx l1-b2 xxxxxxx xxxxxxxxxxxxx * L2 xxxxxxxxxx xxxxxxxxxxxxx Signed-off-by: Markus Heiser <> Signed-off-by: Jonathan Corbet <>
2016-10-04Merge tag 'docs-4.9' of git:// Torvalds
Pull documentation updates from Jonathan Corbet: "This is the documentation update pull for the 4.9 merge window. The Sphinx transition is still creating a fair amount of work. Here we have a number of fixes and, importantly, a proper PDF output solution, thanks to Jani Nikula, Mauro Carvalho Chehab and Markus Heiser. I've started a couple of new books: a driver API book (based on the old device-drivers.tmpl) and a development tools book. Both are meant to show how we can integrate together our existing documentation into a more coherent and accessible whole. It involves moving some stuff around and formatting changes, but, I think, the results are worth it. The good news is that most of our existing Documentation/*.txt files are *almost* in RST format already; the amount of messing around required is minimal. And, of course, there's the usual set of updates, typo fixes, and more" * tag 'docs-4.9' of git:// (120 commits) URL changed for Linux Foundation TAB dax : Fix documentation with respect to struct pages iio: Documentation: Correct the path used to create triggers. docs: Remove space-before-label guidance from CodingStyle docs-rst: add inter-document cross references Documentation/email-clients.txt: convert it to ReST markup Documentation/kernel-docs.txt: reorder based on timestamp Documentation/kernel-docs.txt: Add dates for online docs Documentation/kernel-docs.txt: get rid of broken docs Documentation/kernel-docs.txt: move in-kernel docs Documentation/kernel-docs.txt: remove more legacy references Documentation/kernel-docs.txt: add two published books Documentation/kernel-docs.txt: sort books per publication date Documentation/kernel-docs.txt: adjust LDD references Documentation/kernel-docs.txt: some improvements on the ReST output Documentation/kernel-docs.txt: Consistent indenting: 4 spaces Documentation/kernel-docs.txt: Add 4 paper/book references Documentation/kernel-docs.txt: Improve layouting of book list Documentation/kernel-docs.txt: Remove offline or outdated entries docs: Clean up bare :: lines ...
2016-09-20doc-rst: add CSS styles for :kbd: and :menuselection:Mauro Carvalho Chehab
As we're about to use those two markups, add them to the theme style overrride. Signed-off-by: Mauro Carvalho Chehab <> Signed-off-by: Jonathan Corbet <>
2016-08-14doc-rst: customize RTD theme, drop padding of inline literalMarkus Heiser
Remove the distracting (left/right) padding of inline literals. (HTML <code>). Requested and discussed in [1]. [1] Signed-off-by: Markus Heiser <> Acked-by: Hans Verkuil <> Signed-off-by: Jonathan Corbet <>
2016-07-19[media] doc-rst: backward compatibility with older Sphinx versionsMauro Carvalho Chehab
Sphinx is really evil when an older version finds an extra attribute for the :toctree: tag: it simply ignores everything and produce documents without any chapter inside! As we're now using tags available only on Sphinx 1.4.x, we need to use some creative ways to add a title before the table of contents. Do that by using a css class. Signed-off-by: Mauro Carvalho Chehab <>
2016-07-05doc-rst: customize RTD theme, captions & inline literalMarkus Heiser
The layout of (table) captions in the RTD theme is a bit ugly and the bordered, red colored of inline literals is a bit to gaudy. The requirements has been discussed in the ML [1]. captions: - captions should have 100% (not 85%) font size - hide the permalink symbol as long as link is not hovered inline literal: - drop the borderbox and red color [1] Signed-off-by: Markus Heiser <>
2016-07-05doc-rst: customize RTD theme, table & full widthMarkus Heiser
The default table layout of the RTD theme does not fit for vast tables, like the ones we have in the linux_tv project. This has been discussed on the ML [1]. The RTD theme is a two column layout, with a navigation column on the left and a content column on the right: content column RTD theme's default is 800px as max width for the content, but we have tables with tons of columns, which need the full width of the view-port (BTW: *full width* is what DocBook's HTML is). table - sequences of whitespace should collapse into a single whitespace. - make the overflow auto (scrollbar if needed) - align caption "left" ("center" is unsuitable on vast tables) [1] Signed-off-by: Markus Heiser <>
2016-07-05doc-rst: boilerplate HTML theme customizationMarkus Heiser
Implements the minimal boilerplate for Sphinx HTML theme customization. Signed-off-by: Markus Heiser <> Signed-off-by: Mauro Carvalho Chehab <>