alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 00:36:01 -04:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs: Set a default IDF_PATH in docs build (needed for RTD)

Browse Source 
RTD builds don't set IDF_PATH, mqtt component uses this variable.
This commit is contained in:
Angus Gratton 2018-09-14 09:42:57 +10:00 committed by Angus Gratton
parent e6e2d7ebee
commit 44e4535c90
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/conf_common.py
View File

@ -27,10 +27,17 @@ import shlex
from local_util import run_cmd_get_output, copy_if_modified from local_util import run_cmd_get_output, copy_if_modified
builddir = '_build'
builddir = builddir try:
if 'BUILDDIR' in os.environ:
builddir = os.environ['BUILDDIR'] builddir = os.environ['BUILDDIR']
except KeyError:
builddir = '_build'
# Fill in a default IDF_PATH if it's missing (ie when Read The Docs is building the docs)
try:
idf_path = os.environ['IDF_PATH']
except KeyError:
idf_path = os.path.realpath(os.path.join(os.path.dirname(__file__), '..'))
def call_with_python(cmd): def call_with_python(cmd):
# using sys.executable ensures that the scripts are called with the same Python interpreter # using sys.executable ensures that the scripts are called with the same Python interpreter
@ -62,6 +69,7 @@ confgen_args = [sys.executable,
"--create-config-if-missing", "--create-config-if-missing",
"--env", "COMPONENT_KCONFIGS={}".format(kconfigs), "--env", "COMPONENT_KCONFIGS={}".format(kconfigs),
"--env", "COMPONENT_KCONFIGS_PROJBUILD={}".format(kconfig_projbuilds), "--env", "COMPONENT_KCONFIGS_PROJBUILD={}".format(kconfig_projbuilds),
"--env", "IDF_PATH={}".format(idf_path),
"--output", "docs", kconfig_inc_path + '.in' "--output", "docs", kconfig_inc_path + '.in'
] ]
subprocess.check_call(confgen_args) subprocess.check_call(confgen_args)