linux/Documentation/doc-guide, branch v4.14

sphinx.rst: Allow Sphinx version 1.6 at the docs

2017-08-26T21:50:27Z

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

sphinx.rst: document scripts/sphinx-pre-install script

2017-07-23T21:51:45Z

Now that we have a script to check for Sphinx dependencies, document it. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet

sphinx.rst: better organize the documentation about PDF build

2017-07-17T19:18:42Z

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

sphinx.rst: describe the install requirements for kfigure

2017-07-17T19:18:36Z

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

sphinx.rst: fix unknown reference

2017-07-17T19:18:30Z

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

sphinx.rst: explain the usage of virtual environment

2017-07-17T19:18:24Z

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

docs-rst: move Sphinx install instructions to sphinx.rst

2017-07-17T19:18:18Z

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

kernel-doc: describe the ``literal`` syntax

2017-05-16T11:44:24Z

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

docs: update old references for DocBook from the documentation

2017-05-16T11:44:19Z

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

docs: remove DocBook from the building system

2017-05-16T11:44:19Z

Now that we don't have any DocBook anymore, remove it from the building system. Signed-off-by: Mauro Carvalho Chehab