Skip to content

Commit

Permalink
bugfix/build_docs_add_warning_check: Added null value check for warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
supreetd21 committed Feb 12, 2020
1 parent 7f4309d commit ef7b5ff
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 9 deletions.
8 changes: 1 addition & 7 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,7 @@ examples/**/sdkconfig.old
examples/**/build

# Doc build artifacts
docs/*/_build/
docs/*/doxygen-warning-log.txt
docs/*/sphinx-warning-log.txt
docs/*/sphinx-warning-log-sanitized.txt
docs/*/xml/
docs/*/xml_in/
docs/*/man/
docs/_build/
docs/doxygen_sqlite3.db

# Downloaded font files
Expand Down
2 changes: 2 additions & 0 deletions docs/build_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ def main():
targets = [args.target]

if args.action == "build" or args.action is None:
if args.action is None:
args.check_warnings_only = False
sys.exit(action_build(args))

if args.action == "linkcheck":
Expand Down
5 changes: 3 additions & 2 deletions docs/idf_extensions/run_doxygen.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,12 @@ def generate_doxygen(app, project_description):

# Call Doxygen to get XML files from the header files
print("Calling Doxygen to generate latest XML files")
doxy_env = {
doxy_env = os.environ
doxy_env.update({
"ENV_DOXYGEN_DEFINES": " ".join(defines),
"IDF_PATH": app.config.idf_path,
"IDF_TARGET": app.config.idf_target,
}
})
doxyfile = os.path.join(app.config.docs_root, "Doxyfile")
print("Running doxygen with doxyfile {}".format(doxyfile))
# note: run Doxygen in the build directory, so the xml & xml_in files end up in there
Expand Down

0 comments on commit ef7b5ff

Please sign in to comment.