docs: remove .toc-title class

The "toc-title" class was introduced in commit ef88f10eb877
("[media] doc-rst: backward compatibility with older Sphinx versions")
as a workaround for Sphinx versions o

docs: remove .toc-title class

The "toc-title" class was introduced in commit ef88f10eb877
("[media] doc-rst: backward compatibility with older Sphinx versions")
as a workaround for Sphinx versions older than 1.4.x. However, these
old versions have been deprecated since commit 31abfdda6527
("docs: Deprecate use of Sphinx < 2.4.x").

Having now changed all the toc-title users to use the :caption:
attribute, we can also remove the custom style.

Note that the toc-title class is separate from the "kernel-toc"
logic that was introduced in commit c404f5d4f099 ("docs: Add more
information to the HTML sidebar").

Cc: Mauro Carvalho Chehab <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Signed-off-by: Vegard Nossum <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Link: https://lore.kernel.org/r/[email protected]

show more ...

docs: add support for RTD dark mode

This is actually an overlay on the top of the RTD theme, which
requires to include first the RTD theme.

It should be noticed that, when the dark theme is used, t

docs: add support for RTD dark mode

This is actually an overlay on the top of the RTD theme, which
requires to include first the RTD theme.

It should be noticed that, when the dark theme is used, the
DOCS_CSS files won't be the last CSS themes. So, it won't
override the dark.css style by default. So, it is needed
to force the them override with "!important".

This small script, for instance, produces a nice output with
the RTD dark theme:

DOCS_THEME=sphinx_rtd_dark_mode
cat << EOF > dark_override.css
html body {
font-family: arial,helvetica,sans-serif;
}
html[data-theme='dark'] body {
color: white !important;
}
html[data-theme='dark'] .sig-name {
color: green !important;
}
html[data-theme='dark'] .wy-menu-vertical a {
color: #ffcc00 !important;
}
html[data-theme="dark"] h1, html[data-theme="dark"] h2, html[data-theme="dark"] h3 {
color: #ffcc00 !important;
}
html[data-theme="dark"] h4, html[data-theme="dark"] h5, html[data-theme="dark"] h6 {
color: #ffcc00 !important;
}
html[data-theme="dark"] h7, html[data-theme="dark"] h8, html[data-theme="dark"] h9 {
color: #ffcc00 !important;
}
html[data-theme="dark"] .wy-nav-content a, html[data-theme="dark"] .wy-nav-content a:visited {
color: #ffcc00 !important;
}
EOF

make DOCS_CSS=dark_override.css DOCS_THEME=sphinx_rtd_dark_mode htmldocs

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Link: https://lore.kernel.org/r/90d316e055ef7f4c9021b9eada8f8d3b2e750a66.1638870323.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

doc-rst: Reduce CSS padding around Field

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

doc-rst: Reduce CSS padding around Field

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":

https://www.kernel.org/doc/html/latest/accounting/psi.html

This patch fixes this by lowering the padding with a more specific CSS.

Signed-off-by: Kees Cook <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs: improve readability for people with poorer eyesight

My eyesight is not in good shape, which means that I have difficulty
reading the online Linux documentation. Specifically, body text is
odd

docs: improve readability for people with poorer eyesight

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 <[email protected]>
Acked-by: Dave Chinner <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs RTD theme: code-block with line nos - lines and line numbers don't line up.

In a code-block with line numbers (option :lineno:) there is a
misalignment of the rendered source code lines on the

docs RTD theme: code-block with line nos - lines and line numbers don't line up.

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.

https://github.com/rtfd/sphinx_rtd_theme/issues/419

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 <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs RDT theme: fix bottom margin of lists items

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

docs RDT theme: fix bottom margin of lists items

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 <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

doc-rst: add CSS styles for :kbd: and :menuselection:

As we're about to use those two markups, add them to the
theme style overrride.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>

doc-rst: add CSS styles for :kbd: and :menuselection:

As we're about to use those two markups, add them to the
theme style overrride.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

doc-rst: customize RTD theme, drop padding of inline literal

Remove the distracting (left/right) padding of inline literals. (HTML
<code>). Requested and discussed in [1].

[1] http://www.spinics.ne

doc-rst: customize RTD theme, drop padding of inline literal

Remove the distracting (left/right) padding of inline literals. (HTML
<code>). Requested and discussed in [1].

[1] http://www.spinics.net/lists/linux-media/msg103991.html

Signed-off-by: Markus Heiser <[email protected]>
Acked-by: Hans Verkuil <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

[media] doc-rst: backward compatibility with older Sphinx versions

Sphinx is really evil when an older version finds an extra
attribute for the :toctree: tag: it simply ignores everything
and produc

[media] doc-rst: backward compatibility with older Sphinx versions

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 <[email protected]>

show more ...

doc-rst: customize RTD theme, captions & inline literal

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
requirem

doc-rst: customize RTD theme, captions & inline literal

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] http://article.gmane.org/gmane.linux.drivers.video-input-infrastructure/101099

Signed-off-by: Markus Heiser <[email protected]>

show more ...

doc-rst: customize RTD theme, table & full width

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

doc-rst: customize RTD theme, table & full width

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] http://article.gmane.org/gmane.linux.kernel/2216509

Signed-off-by: Markus Heiser <[email protected]>

show more ...

doc-rst: boilerplate HTML theme customization

Implements the minimal boilerplate for Sphinx HTML theme customization.

Signed-off-by: Markus Heiser <[email protected]>
Signed-off-by: Mauro C

doc-rst: boilerplate HTML theme customization

Implements the minimal boilerplate for Sphinx HTML theme customization.

Signed-off-by: Markus Heiser <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>

show more ...