alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-08 04:02:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move Doxygen build to a Sphinx extension, load sdkconfig & soc caps headers

Browse Source
This commit is contained in:
Angus Gratton
2019-11-12 18:42:03 +08:00
committed by Angus Gratton
parent fcf76320c8
commit 783856d557
9 changed files with 194 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/conf_common.py
View File

@@ -25,7 +25,7 @@ import subprocess
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute
from local_util import run_cmd_get_output, copy_if_modified
from local_util import run_cmd_get_output, copy_if_modified, call_with_python
# build_docs on the CI server sometimes fails under Python3. This is a workaround:
sys.setrecursionlimit(3500)
@@ -46,29 +46,10 @@ except KeyError:
# Set the idf_target chip. This is a hack right now.
idf_target = 'esp32s2'
def call_with_python(cmd):
# using sys.executable ensures that the scripts are called with the same Python interpreter
if os.system('{} {}'.format(sys.executable, cmd)) != 0:
raise RuntimeError('{} failed'.format(cmd))
# Call Doxygen to get XML files from the header files
print("Calling Doxygen to generate latest XML files")
if os.system("doxygen ../Doxyfile") != 0:
raise RuntimeError('Doxygen call failed')
# Doxygen has generated XML files in 'xml' directory.
# Copy them to 'xml_in', only touching the files which have changed.
copy_if_modified('xml/', 'xml_in/')
# Generate 'api_name.inc' files using the XML files by Doxygen
call_with_python('../gen-dxd.py')
# Generate 'esp_err_defs.inc' file with ESP_ERR_ error code definitions
esp_err_inc_path = '{}/inc/esp_err_defs.inc'.format(builddir)
call_with_python('../../tools/gen_esp_err_to_name.py --rst_output ' + esp_err_inc_path + '.in')
copy_if_modified(esp_err_inc_path + '.in', esp_err_inc_path)
try:
os.mkdir(builddir)
except OSError:
pass
# Generate version-related includes
#
@@ -79,7 +60,6 @@ def generate_version_specific_includes(app):
call_with_python('../gen-version-specific-includes.py {} {}'.format(app.config.language, version_tmpdir))
copy_if_modified(version_tmpdir, '{}/inc'.format(builddir))
# Generate toolchain download links
print("Generating toolchain download links")
base_url = 'https://dl.espressif.com/dl/'
@@ -118,6 +98,7 @@ extensions = ['breathe',
'html_redirects',
'idf_build_system',
'kconfig_reference',
'doxygen_idf',
'sphinx.ext.todo',
]