doc-rst: add media/conf_nitpick.py
authorMarkus Heiser <markus.heiser@darmarIT.de>
Sat, 13 Aug 2016 14:12:44 +0000 (16:12 +0200)
committerJonathan Corbet <corbet@lwn.net>
Sun, 14 Aug 2016 17:52:23 +0000 (11:52 -0600)
commit482941aa84a6224b3e45f8d52de75c0c0de51391
treed6f5c9e954bf1381ad03002bd0590bb0ca8f26da
parentb32febad77068b4a28daf7b7e063438d0cca8a42
doc-rst: add media/conf_nitpick.py

The media/conf_nitpick.py is a *build-theme* wich uses the nit-picking
mode of sphinx. To compile only the html of 'media' with the nit-picking
build use::

  make SPHINXDIRS=media SPHINX_CONF=conf_nitpick.py htmldocs

With this, the Documentation/conf.py is read first and updated with the
configuration values from the Documentation/media/conf_nitpick.py.

The origin media/conf_nitpick.py comes from Mauro's experimental
docs-next branch::

  https://git.linuxtv.org/mchehab/experimental.git mchehab/docs-next

BTW fixed python indentation in media/conf_nitpick.py.  Python
indentation is 4 spaces [1] and Python 3 disallows mixing the use of
tabs and spaces for indentation [2].

[1] https://www.python.org/dev/peps/pep-0008/#indentation
[2] https://www.python.org/dev/peps/pep-0008/#tabs-or-spaces

Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/media/conf_nitpick.py [new file with mode: 0644]