mirror of
https://github.com/flipperdevices/flipperzero-firmware.git
synced 2025-12-12 04:41:26 +04:00
fbt: doxygen target (#3510)
* fbt: doxygen target * github: adjustments for doxygen * github: always generate docs, only upload for dev * doxygen: fixed exclusion path for awesome-css * github: stricter check for push ref * github: bumped action version to fix node.js deprecation * github: added PVS report url to workflow summary * github: pvs: reworked report URL handling * github: added size report to summary * docs: added `doxygen` target * fbt: common naming scheme for COMSTR * Documentation: fix warnings and errors * Doxygen: stricter warning checks * fbt: "doxy" target, opens generated doxygen documentation in browser * github: doxygen: now using edge (1.10) version Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
18
SConstruct
18
SConstruct
@@ -7,7 +7,7 @@
|
||||
# construction of certain targets behind command-line options.
|
||||
|
||||
import os
|
||||
from fbt.util import path_as_posix
|
||||
from fbt.util import path_as_posix, open_browser_action
|
||||
|
||||
DefaultEnvironment(tools=[])
|
||||
|
||||
@@ -42,6 +42,7 @@ distenv = coreenv.Clone(
|
||||
"openocd",
|
||||
"blackmagic",
|
||||
"jflash",
|
||||
"doxygen",
|
||||
],
|
||||
ENV=os.environ,
|
||||
UPDATE_BUNDLE_DIR="dist/${DIST_DIR}/f${TARGET_HW}-update-${DIST_SUFFIX}",
|
||||
@@ -419,3 +420,18 @@ distenv.PhonyTarget(
|
||||
"env",
|
||||
"@echo $( ${FBT_SCRIPT_DIR.abspath}/toolchain/fbtenv.sh $)",
|
||||
)
|
||||
|
||||
doxy_build = distenv.DoxyBuild(
|
||||
"documentation/doxygen/build/html/index.html",
|
||||
"documentation/doxygen/Doxyfile-awesome.cfg",
|
||||
doxy_env_variables={
|
||||
"DOXY_SRC_ROOT": Dir(".").abspath,
|
||||
"DOXY_BUILD_DIR": Dir("documentation/doxygen/build").abspath,
|
||||
"DOXY_CONFIG_DIR": "documentation/doxygen",
|
||||
},
|
||||
)
|
||||
distenv.Alias("doxygen", doxy_build)
|
||||
distenv.AlwaysBuild(doxy_build)
|
||||
|
||||
# Open generated documentation in browser
|
||||
distenv.PhonyTarget("doxy", open_browser_action, source=doxy_build)
|
||||
|
||||
Reference in New Issue
Block a user