Skip to content
  • Markus Heiser's avatar
    doc-rst: generic way to build only sphinx sub-folders · 606b9ac8
    Markus Heiser authored
    
    
    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: default avatarMarkus Heiser <markus.heiser@darmarIT.de>
    Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
    606b9ac8