瀏覽代碼

bugfix/build_docs_add_warning_check: Added null value check for warnings

Supreet Deshpande 6 年之前
父節點
當前提交
ef7b5ff9e4
共有 3 個文件被更改,包括 6 次插入9 次删除
  1. 1 7
      .gitignore
  2. 2 0
      docs/build_docs.py
  3. 3 2
      docs/idf_extensions/run_doxygen.py

+ 1 - 7
.gitignore

@@ -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

+ 2 - 0
docs/build_docs.py

@@ -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":

+ 3 - 2
docs/idf_extensions/run_doxygen.py

@@ -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