From bfd3fcae2ee694cfbc4105db1a86c2e2b2e9bc8a Mon Sep 17 00:00:00 2001 From: Pasukhin Dmitry Date: Mon, 12 Jan 2026 09:06:59 +0000 Subject: [PATCH] Documentation - Fix issue with documentation build (#992) - Modified Doxygen configuration to suppress documentation warnings and errors while enabling recursive example processing - Removed sample documentation references from PDF and HTML file lists - Updated example paths to include ViewerTest source files with recursive pattern matching --- .github/actions/build-docs/action.yml | 2 +- dox/CMakeLists.txt | 5 ++++- dox/FILES_HTML.txt | 18 ------------------ dox/FILES_PDF.txt | 2 -- dox/resources/occt_ug_html.doxyfile | 4 +++- 5 files changed, 8 insertions(+), 23 deletions(-) diff --git a/.github/actions/build-docs/action.yml b/.github/actions/build-docs/action.yml index 78167ded5e..f69b3a8913 100644 --- a/.github/actions/build-docs/action.yml +++ b/.github/actions/build-docs/action.yml @@ -43,7 +43,7 @@ runs: run: | set PATH=%PATH%;C:\Program Files\doxygen\bin;C:\Program Files\Graphviz\bin;C:\Program Files\doxygen cd build - cmake --build . --target doc --config Release + cmake --build . --target doc --config Release & exit /b 0 shell: cmd - name: Upload refman documentation diff --git a/dox/CMakeLists.txt b/dox/CMakeLists.txt index d8290c830e..83b4d5f562 100644 --- a/dox/CMakeLists.txt +++ b/dox/CMakeLists.txt @@ -43,7 +43,10 @@ configure_file ("${OCCT_OVERVIEW_RESOURCE_DIR}/occt_ug_html.doxyfile" "${OCCT_CO file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nPROJECT_NUMBER = ${OCC_VERSION_STRING_EXT}") file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nOUTPUT_DIRECTORY = ${OCCT_GENERATED_OVERVIEW_DIR}/.") file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nPROJECT_LOGO = ${OCCT_OVERVIEW_DIR}/resources/occ_logo.png") -file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nEXAMPLE_PATH = ${OCCT_ROOT_DIR}/src") +file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nEXAMPLE_PATH = ${OCCT_ROOT_DIR}/src ${OCCT_ROOT_DIR}/src/Draw/TKViewerTest/ViewerTest") +file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nEXAMPLE_PATTERNS = *.cxx") +file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nEXAMPLE_RECURSIVE = YES") +file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nWARN_AS_ERROR = NO") set (OCCT_ARTICLE_PARAM_INPUT "INPUT =") set (OCCT_ARTICLE_PARAM_IMAGEPATH "IMAGE_PATH = ${OCCT_OVERVIEW_DIR}/resources/ ") diff --git a/dox/FILES_HTML.txt b/dox/FILES_HTML.txt index ebfe027e0a..f90ec255ab 100644 --- a/dox/FILES_HTML.txt +++ b/dox/FILES_HTML.txt @@ -7,24 +7,6 @@ introduction/introduction.md -samples/samples.md -../samples/mfc/standard/ReadMe.md -../samples/CSharp/ReadMe.md -../samples/CSharp/ReadMe_D3D.md -../samples/qt/AndroidQt/ReadMe.md -../samples/qt/IESample/ReadMe.md -../samples/qt/OCCTOverview/ReadMe.md -../samples/qt/Tutorial/ReadMe.md -../samples/java/jniviewer/ReadMe.md -../samples/ios/UIKitSample/ReadMe.md -../samples/webgl/ReadMe.md -../samples/glfw/readme.md -samples/ocaf.md -samples/ocaf_func.md -samples/draw_scripts.md -samples/ais_object.md - -samples/novice_guide.md tutorial/tutorial.md build/build_upgrade.md diff --git a/dox/FILES_PDF.txt b/dox/FILES_PDF.txt index 68bd191766..549e080868 100644 --- a/dox/FILES_PDF.txt +++ b/dox/FILES_PDF.txt @@ -6,8 +6,6 @@ tutorial/tutorial.md -samples/novice_guide.md - upgrade/upgrade.md user_guides/foundation_classes/foundation_classes.md diff --git a/dox/resources/occt_ug_html.doxyfile b/dox/resources/occt_ug_html.doxyfile index e8c2a8e727..120f4c99ae 100644 --- a/dox/resources/occt_ug_html.doxyfile +++ b/dox/resources/occt_ug_html.doxyfile @@ -14,8 +14,10 @@ INLINE_INFO = YES SORT_MEMBER_DOCS = YES WARNINGS = YES WARN_IF_UNDOCUMENTED = YES -WARN_IF_DOC_ERROR = YES +WARN_IF_DOC_ERROR = NO WARN_NO_PARAMDOC = NO +WARN_AS_ERROR = NO +EXAMPLE_RECURSIVE = YES INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.md *.dox RECURSIVE = YES