From 8b38e9ecf57d3c274de30f5f99ac087c54c99bd1 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Tue, 24 Aug 2021 17:40:11 +0800 Subject: [PATCH] docs: fix edit on github link to point to esp-idf Also add check for IDF_PATH for better error feedback --- docs/conf_common.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/conf_common.py b/docs/conf_common.py index b657c81fb9..46dcddd920 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -15,6 +15,9 @@ import os.path from esp_docs.conf_docs import * # noqa: F403,F401 +if os.environ.get('IDF_PATH') is None: + raise RuntimeError('IDF_PATH should be set, run export.sh before building docs') + BT_DOCS = ['api-guides/blufi.rst', 'api-guides/esp-ble-mesh/**', 'api-reference/bluetooth/**'] @@ -131,7 +134,7 @@ github_repo = 'espressif/esp-idf' # context used by sphinx_idf_theme html_context['github_user'] = 'espressif' -html_context['github_repo'] = 'esp-docs' +html_context['github_repo'] = 'esp-idf' # Extra options required by sphinx_idf_theme project_slug = 'esp-idf'