27 Aug, 2017
1 commit
-
Now that the PDF building issues with Sphinx 1.6 got fixed,
update the documentation and scripts accordingly.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet
24 Jul, 2017
1 commit
-
Now that we have a script to check for Sphinx dependencies,
document it.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet
18 Jul, 2017
5 commits
-
Instead of having it on just one note, add a separate section.
This way, we could later improve it, providing a better
guide about the needed steps for PDF builds.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
As we now have a document describing the install
requirements for Sphinx, add there the need for GraphViz
and ImageMagick.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
There's no "Sphinx C Domain" reference at the Kernel
documentation. So, don't use references for it.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
As the Sphinx build seems very fragile, specially for
PDF output, add a notice about how to use it on a virtual
environment.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
The toolchain used by Sphinx is somewhat complex, and installing
it should be part of the doc-guide.Move it out of changes.rst.
Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet
16 May, 2017
3 commits
-
changeset b97f193abf83 ("scripts/kernel-doc: fix parser
for apostrophes") added support for ``literal`` inside
kernel-doc, in order to allow using the "%" symbol inside
a literal block, as this is used at printk() description.Document it.
Fixes: b97f193abf83 ("scripts/kernel-doc: fix parser for apostrophes")
Signed-off-by: Mauro Carvalho Chehab -
DocBook is mentioned several times at the documentation. Update
the obsolete references from it at the DocBook.Acked-by: SeongJae Park
Signed-off-by: Mauro Carvalho Chehab -
Now that we don't have any DocBook anymore, remove it from
the building system.Signed-off-by: Mauro Carvalho Chehab
09 Mar, 2017
2 commits
-
This patch brings scalable figure, image handling and a concept to
embed *render* markups:* DOT (http://www.graphviz.org)
* SVGFor image handling use the 'image' replacement::
.. kernel-image:: svg_image.svg
:alt: simple SVG imageFor figure handling use the 'figure' replacement::
.. kernel-figure:: svg_image.svg
:alt: simple SVG imageSVG image example
Embed *render* markups (or languages) like Graphviz's **DOT** is
provided by the *render* directive.::.. kernel-render:: DOT
:alt: foobar digraph
:caption: Embedded **DOT** (Graphviz) code.digraph foo {
"bar" -> "baz";
}The *render* directive is a concept to integrate *render* markups and
languages, yet supported markups:* DOT: render embedded Graphviz's **DOT**
* SVG: render embedded Scalable Vector Graphics (**SVG**)Cc: Jani Nikula
Cc: Laurent Pinchart
Tested-by: Mauro Carvalho Chehab
Tested-by: Daniel Vetter
Signed-off-by: Daniel Vetter (v2 - v5)
Signed-off-by: Markus Heiser (v1, v6)
Signed-off-by: Jonathan Corbet -
We're still pretty far away from anything like a consensus, but
there's clearly a lot of people who prefer an as-light as possible
approach to converting existing .txt files to .rst. Make sure this is
properly taken into account and clear.Motivated by discussions with Peter and Christoph and others.
Cc: Christoph Hellwig
Cc: Peter Zijlstra
Cc: Jani Nikula
Cc: Mauro Carvalho Chehab
Signed-off-by: Daniel Vetter
Signed-off-by: Jonathan Corbet
01 Dec, 2016
1 commit
-
Keeping both rst and in-file documentation in sync can be harsh.
So, simplify the script's internal documntation to a bare minimum,
and add a mention to the ReST file with its full documentation.This way, a quick help is still available at the command line,
while the complete one is maintained at the ReST format.As we won't be using pad2rst anymore, do a cleanup at the ReST
file.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet
20 Nov, 2016
4 commits
-
The pod2rst tool generated a man page for parse-headers.pl
script, but it is better to put it into some context.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Provide a man page for parse-headers.pl, describing
how to use it.The documentation on ReST format was generated via pod2rst:
http://search.cpan.org/~dowens/Pod-POM-View-Restructured-0.02/bin/pod2rstSigned-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet -
Having the kernel-documentation at the topmost level doesn't
allow generating a separate PDF file for it. Also, makes harder
to add extra contents. So, place it on a sub-dir.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet