linux/Documentation/sphinx
Markus Heiser 606b9ac81a doc-rst: generic way to build only sphinx sub-folders
Add a generic way to build only a reST sub-folder with or
without a individual *build-theme*.

* control *sub-folders* by environment SPHINXDIRS
* control *build-theme* by environment SPHINX_CONF

Folders with a conf.py file, matching $(srctree)/Documentation/*/conf.py
can be build and distributed *stand-alone*. E.g. to compile only the
html of 'media' and 'gpu' folder use::

  make SPHINXDIRS="media gpu" htmldocs

To use an additional sphinx-build configuration (*build-theme*) set the
name of the configuration file to SPHINX_CONF. E.g. 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.

Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-14 11:51:51 -06:00
..
convert_template.sed Documentation/sphinx: nicer referencing of struct in docbook->rst conversion 2016-05-30 13:38:54 +03:00
kernel_include.py doc-rst: add kernel-include directive 2016-07-08 09:31:04 -03:00
kernel-doc.py doc-rst: kernel-doc directive, fix state machine reporter 2016-07-20 16:51:12 -06:00
load_config.py doc-rst: generic way to build only sphinx sub-folders 2016-08-14 11:51:51 -06:00
parse-headers.pl doc-rst: parse-headers: remove trailing spaces 2016-07-09 09:42:31 -03:00
post_convert.sed Documentation/sphinx: nicer referencing of struct in docbook->rst conversion 2016-05-30 13:38:54 +03:00
rstFlatTable.py doc-rst: flat-table directive - initial implementation 2016-06-30 12:58:33 -06:00
tmplcvt sphinx: cheesy script to convert .tmpl files 2016-05-30 13:38:53 +03:00