diff options
author | Markus Heiser <markus.heiser@darmarIT.de> | 2016-08-13 16:12:42 +0200 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2016-08-14 11:51:51 -0600 |
commit | 606b9ac81a63ab3adb7e61206b9ae34ee186a89d (patch) | |
tree | 8ff0fcf5ec5d762a0ad7fc7e05fbbeb8d17f6801 /Documentation/index.rst | |
parent | 3eb6cd6834c356f40e1633a0ced4ff9a4c59936b (diff) | |
download | linux-stable-606b9ac81a63ab3adb7e61206b9ae34ee186a89d.tar.gz linux-stable-606b9ac81a63ab3adb7e61206b9ae34ee186a89d.tar.bz2 linux-stable-606b9ac81a63ab3adb7e61206b9ae34ee186a89d.zip |
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>
Diffstat (limited to 'Documentation/index.rst')
0 files changed, 0 insertions, 0 deletions