05 Oct, 2016
1 commit
-
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://git.lwn.net/linux: (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
...
21 Sep, 2016
1 commit
-
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
15 Aug, 2016
1 commit
-
Remove the distracting (left/right) padding of inline literals. (HTML
). Requested and discussed in [1].[1] http://www.spinics.net/lists/linux-media/msg103991.html
Signed-off-by: Markus Heiser
Acked-by: Hans Verkuil
Signed-off-by: Jonathan Corbet
19 Jul, 2016
1 commit
-
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
06 Jul, 2016
3 commits
-
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 hoveredinline literal:
- drop the borderbox and red color
[1] http://article.gmane.org/gmane.linux.drivers.video-input-infrastructure/101099
Signed-off-by: Markus 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] http://article.gmane.org/gmane.linux.kernel/2216509
Signed-off-by: Markus Heiser
-
Implements the minimal boilerplate for Sphinx HTML theme customization.
Signed-off-by: Markus Heiser
Signed-off-by: Mauro Carvalho Chehab