mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
49 lines
1.9 KiB
Python
49 lines
1.9 KiB
Python
|
# Sphinx extension to integrate IDF build system information
|
||
|
|
# into the Sphinx Build
|
||
|
|
#
|
||
|
|
# Runs early in the Sphinx process, runs CMake to generate the dummy IDF project
|
||
|
|
# in this directory - including resolving paths, etc.
|
||
|
|
#
|
||
|
|
# Then emits the new 'idf-info' event which has information read from IDF
|
||
|
|
# build system, that other extensions can use to generate relevant data.
|
||
|
|
import os.path
|
||
|
|
import sys
|
||
|
|
import subprocess
|
||
|
|
import json
|
||
|
|
|
||
|
|
# this directory also contains the dummy IDF project
|
||
|
|
project_path = os.path.abspath(os.path.dirname(__file__))
|
||
|
|
project_build_dir = os.path.join(project_path, "build")
|
||
|
|
|
||
|
|
def setup(app):
|
||
|
|
builddir = os.path.dirname(app.doctreedir.rstrip(os.sep))
|
||
|
|
app.add_config_value('idf_path', os.environ.get("IDF_PATH", ""), 'env')
|
||
|
|
app.add_config_value('idf_target', 'esp32', 'env')
|
||
|
|
app.add_event('idf-info')
|
||
|
|
|
||
|
|
# Attaching the generate event to env-get-outdated is a bit of a hack,
|
||
|
|
# we want this to run early in the docs build but unclear exactly when
|
||
|
|
app.connect('env-get-outdated', generate_idf_info)
|
||
|
|
|
||
|
|
def generate_idf_info(app, env, added, changed, removed):
|
||
|
|
print("Running CMake on dummy project to get build info...")
|
||
|
|
idf_py_path = os.path.join(app.config.idf_path, "tools", "idf.py")
|
||
|
|
print("Running idf.py...")
|
||
|
|
subprocess.check_call([sys.executable,
|
||
|
|
idf_py_path,
|
||
|
|
"-C",
|
||
|
|
project_path,
|
||
|
|
"set-target",
|
||
|
|
app.config.idf_target])
|
||
|
|
# TODO: can call these in one execution pass?
|
||
|
|
subprocess.check_call([sys.executable,
|
||
|
|
idf_py_path,
|
||
|
|
"-C",
|
||
|
|
project_path,
|
||
|
|
"reconfigure"])
|
||
|
|
with open(os.path.join(project_build_dir, "project_description.json")) as f:
|
||
|
|
project_description = json.load(f)
|
||
|
|
app.emit('idf-info', project_description)
|
||
|
|
|
||
|
|
return []
|