Skip to content

Commit

Permalink
CVS-82186 port to master (openvinotoolkit#11701)
Browse files Browse the repository at this point in the history 
* Add Overview page

* Revert "Add Overview page"

* plugin api separate config (openvinotoolkit#11109)

Co-authored-by: Nikolay Tyukaev <[email protected]>
  • Loading branch information
@xu-yuan1 @ntyukaev
xu-yuan1 and ntyukaev authored May 17, 2022
1 parent 8691b88 commit 31dab59
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 53 deletions.
13 changes: 10 additions & 3 deletions docs/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,10 @@ function(build_docs)
set(DOXYFILE_SOURCE "${DOCS_SOURCE_DIR}/Doxyfile.config")
set(DOXYFILE_BUILD "${DOCS_BUILD_DIR}/Doxyfile.config")
configure_file(${DOXYFILE_SOURCE} ${DOXYFILE_BUILD} @ONLY)
# Doxygen config plugin
set(DOXYFILE_SOURCE_PLUGIN "${DOCS_SOURCE_DIR}/IE_PLUGIN_DG/Doxyfile")
set(DOXYFILE_BUILD_PLUGIN "${DOCS_BUILD_DIR}/Doxyfile.plugin.config")
configure_file(${DOXYFILE_SOURCE_PLUGIN} ${DOXYFILE_BUILD_PLUGIN} @ONLY)

list(APPEND commands COMMAND ${PYTHON_EXECUTABLE} ${DOXY_MD_FILTER}
--input_dir=${OpenVINO_SOURCE_DIR}
Expand Down Expand Up @@ -192,17 +196,20 @@ function(build_docs)

add_custom_target(doxygen_xml
DEPENDS preprocess_docs
COMMAND ${PYTHON_EXECUTABLE} ${REMOVE_XML_SCRIPT} ${XML_OUTPUT}
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_BUILD}
WORKING_DIRECTORY ${DOCS_BUILD_DIR}
COMMENT "Generate doxygen XML output"
VERBATIM)

# Post-process docs
add_custom_command(TARGET doxygen_xml
POST_BUILD
COMMAND ${PYTHON_EXECUTABLE} ${PREPARE_XML_SCRIPT} ${XML_OUTPUT}
COMMAND ${PYTHON_EXECUTABLE} ${REMOVE_XML_SCRIPT} ${XML_OUTPUT}
COMMAND ${CMAKE_COMMAND} -E copy_directory ${DOXYREST_IN} ${DOXYREST_OUT}
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_BUILD_PLUGIN}
COMMAND ${PYTHON_EXECUTABLE} ${PREPARE_XML_SCRIPT} ${XML_OUTPUT}
COMMAND ${DOXYREST_EXECUTABLE} -c ${DOXYREST_CONFIG_OUT}
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_BUILD}
COMMAND ${PYTHON_EXECUTABLE} ${PREPARE_XML_SCRIPT} ${XML_OUTPUT}
COMMAND ${DOXYREST_EXECUTABLE} -c ${DOXYREST_CONFIG_OUT}
COMMAND ${PYTHON_EXECUTABLE} ${COPY_IMAGES_SCRIPT} ${XML_OUTPUT} ${RST_OUTPUT}
COMMAND ${PYTHON_EXECUTABLE} ${DOXYGEN_MAPPING_SCRIPT} ${XML_OUTPUT} ${DOCS_BUILD_DIR} ${OpenVINO_SOURCE_DIR}/../
Expand Down
34 changes: 2 additions & 32 deletions docs/Doxyfile.config
View file
Original file line number Diff line number Diff line change
Expand Up @@ -831,38 +831,7 @@ WARN_LOGFILE = "@DOCS_BUILD_DIR@/doxygen.log"

INPUT = "@MARKDOWN_INPUT@" \
"@OpenVINO_SOURCE_DIR@/src/frontends/common/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/conditional_compilation/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/itt/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/legacy/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/legacy/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/low_precision_transformations/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/low_precision_transformations/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/offline_transformations/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/preprocessing/" \
"@OpenVINO_SOURCE_DIR@/src/common/preprocessing/arm_neon/" \
"@OpenVINO_SOURCE_DIR@/src/common/preprocessing/cpu_x86_avx2/" \
"@OpenVINO_SOURCE_DIR@/src/common/preprocessing/cpu_x86_avx512/" \
"@OpenVINO_SOURCE_DIR@/src/common/preprocessing/cpu_x86_sse42/" \
"@OpenVINO_SOURCE_DIR@/src/common/snippets/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/transformations/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/util/include/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/openvino/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/openvino/core/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/openvino/core/descriptor/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/openvino/core/preprocess/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/openvino/core/type/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/openvino/op/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/openvino/op/util/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/openvino/opsets/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/openvino/pass/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/openvino/pass/pattern/" \
"@OpenVINO_SOURCE_DIR@/src/core/include/openvino/runtime/" \
"@OpenVINO_SOURCE_DIR@/src/core/builder/include/" \
"@OpenVINO_SOURCE_DIR@/src/core/reference/include/" \
"@OpenVINO_SOURCE_DIR@/src/core/shape_inference/include/" \
"@OpenVINO_SOURCE_DIR@/src/frontends/common/include/" \
"@OpenVINO_SOURCE_DIR@/src/inference/dev_api/" \
"@OpenVINO_SOURCE_DIR@/src/inference/include/"


Expand Down Expand Up @@ -913,7 +882,8 @@ RECURSIVE = YES

EXCLUDE = "@OpenVINO_SOURCE_DIR@/thirdparty" \
"@OpenVINO_SOURCE_DIR@/temp" \
"@OpenVINO_SOURCE_DIR@/bin"
"@OpenVINO_SOURCE_DIR@/bin" \
"@DOCS_BUILD_DIR@/openvino/docs/IE_PLUGIN_DG/"

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
Expand Down
47 changes: 29 additions & 18 deletions docs/IE_PLUGIN_DG/Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY =
OUTPUT_DIRECTORY = "@DOCS_BUILD_DIR@"

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
Expand Down Expand Up @@ -228,7 +228,12 @@ TAB_SIZE = 4
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.

ALIASES =
ALIASES = sphinxdirective="\n\xmlonly<sphinxdirective>"
ALIASES += endsphinxdirective="</sphinxdirective>\endxmlonly"
ALIASES += sphinxtabset="\n\xmlonly<sphinxtabset></sphinxtabset>\endxmlonly\n"
ALIASES += endsphinxtabset="\n\xmlonly<endsphinxtabset></endsphinxtabset>\endxmlonly\n"
ALIASES += sphinxtab{1}="\n\xmlonly<sphinxtab>\1</sphinxtab>\endxmlonly\n"
ALIASES += endsphinxtab="\n\xmlonly<endsphinxtab></endsphinxtab>\endxmlonly\n"

# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
Expand Down Expand Up @@ -780,10 +785,16 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = . \
../../src/common/transformations/include/transformations \
../../src/inference/dev_api \
../../src/common/itt/include/openvino
INPUT = "@DOCS_BUILD_DIR@/openvino/docs/IE_PLUGIN_DG/" \
"@OpenVINO_SOURCE_DIR@/src/common/transformations/include/" \
"@OpenVINO_SOURCE_DIR@/src/inference/dev_api" \
"@OpenVINO_SOURCE_DIR@/src/common/itt/include/openvino" \
"@OpenVINO_SOURCE_DIR@/src/common/conditional_compilation/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/low_precision_transformations/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/snippets/include/" \
"@OpenVINO_SOURCE_DIR@/src/common/util/include/" \
"@OpenVINO_SOURCE_DIR@src/core/dev_api"


# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -862,14 +873,14 @@ EXCLUDE_SYMBOLS =
# that contain example code fragments that are included (see the \include
# command).

EXAMPLE_PATH = ../template_plugin/src \
../template_plugin/include \
../template_plugin/src/CMakeLists.txt \
../template_plugin/tests/functional/CMakeLists.txt \
../template_plugin/tests/functional/transformations \
../template_plugin/tests/functional/shared_tests_instances/ \
../../src/tests/functional/plugin/shared/include \
../snippets
EXAMPLE_PATH = "@OpenVINO_SOURCE_DIR@/docs/template_plugin/src" \
"@OpenVINO_SOURCE_DIR@/docs/template_plugin/include" \
"@OpenVINO_SOURCE_DIR@/docs/template_plugin/src/CMakeLists.txt" \
"@OpenVINO_SOURCE_DIR@/template_plugin/tests/functional/CMakeLists.txt" \
"@OpenVINO_SOURCE_DIR@/docs/template_plugin/tests/functional/transformations" \
"@OpenVINO_SOURCE_DIR@/docs/template_plugin/tests/functional/shared_tests_instances/" \
"@OpenVINO_SOURCE_DIR@/src/tests/functional/plugin/shared/include" \
"@OpenVINO_SOURCE_DIR@/docs/snippets"

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
Expand All @@ -891,7 +902,7 @@ EXAMPLE_RECURSIVE = YES
# that contain images that are to be included in the documentation (see the
# \image command).

IMAGE_PATH = ./images
IMAGE_PATH = "@DOCS_BUILD_DIR@/openvino/docs/IE_PLUGIN_DG/images"

# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
Expand Down Expand Up @@ -1068,7 +1079,7 @@ IGNORE_PREFIX =
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.

GENERATE_HTML = YES
GENERATE_HTML = NO

# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
Expand Down Expand Up @@ -1892,15 +1903,15 @@ MAN_LINKS = NO
# captures the structure of the code including all documentation.
# The default value is: NO.

GENERATE_XML = NO
GENERATE_XML = YES

# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: xml.
# This tag requires that the tag GENERATE_XML is set to YES.

XML_OUTPUT = xml
XML_OUTPUT = "@XML_OUTPUT@"

# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
Expand Down

0 comments on commit 31dab59

Please sign in to comment.