diff options
author | Breno Matheus Lima <breno.lima@nxp.com> | 2019-06-05 18:18:30 +0000 |
---|---|---|
committer | Tom Rini <trini@konsulko.com> | 2019-06-20 10:57:08 -0400 |
commit | 656d8da9d2862afd293ae678d37a486d34b76ca2 (patch) | |
tree | 405420ece9ddde3c6e8f66ab65867d128d7761be /doc/sphinx/load_config.py | |
parent | 894e235f145b4f397a474f22c7c604ae925eb114 (diff) |
doc: Remove duplicated documentation directory
Commit ad7061ed742e ("doc: Move device tree bindings documentation to
doc/device-tree-bindings") moved all device tree binding documentation
to doc/device-tree-bindings directory.
The current U-Boot project still have two documentation directories:
- doc/
- Documentation/
Move all documentation and sphinx files to doc directory so all content
can be in a common place.
Signed-off-by: Breno Lima <breno.lima@nxp.com>
Diffstat (limited to 'doc/sphinx/load_config.py')
-rw-r--r-- | doc/sphinx/load_config.py | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/sphinx/load_config.py b/doc/sphinx/load_config.py new file mode 100644 index 0000000000..301a21aa4f --- /dev/null +++ b/doc/sphinx/load_config.py @@ -0,0 +1,32 @@ +# -*- coding: utf-8; mode: python -*- +# pylint: disable=R0903, C0330, R0914, R0912, E0401 + +import os +import sys +from sphinx.util.pycompat import execfile_ + +# ------------------------------------------------------------------------------ +def loadConfig(namespace): +# ------------------------------------------------------------------------------ + + u"""Load an additional configuration file into *namespace*. + + The name of the configuration file is taken from the environment + ``SPHINX_CONF``. The external configuration file extends (or overwrites) the + configuration values from the origin ``conf.py``. With this you are able to + maintain *build themes*. """ + + config_file = os.environ.get("SPHINX_CONF", None) + if (config_file is not None + and os.path.normpath(namespace["__file__"]) != os.path.normpath(config_file) ): + config_file = os.path.abspath(config_file) + + if os.path.isfile(config_file): + sys.stdout.write("load additional sphinx-config: %s\n" % config_file) + config = namespace.copy() + config['__file__'] = config_file + execfile_(config_file, config) + del config['__file__'] + namespace.update(config) + else: + sys.stderr.write("WARNING: additional sphinx-config not found: %s\n" % config_file) |