From 9e9b2b40f7f1b6e6345dc9a418cd3031d1ff0478 Mon Sep 17 00:00:00 2001 From: Andrey Astafyev Date: Sun, 13 Oct 2019 09:29:02 +0300 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD?= =?UTF-8?q?=D1=82=D0=B0=D1=86=D0=B8=D1=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CMakeLists.txt | 19 +----------------- cmake/cmlib | 2 +- doc/CMakeLists.txt | 20 +++++++++++++++++++ doc/{html => }/Doxyfile.in | 6 +++--- .../code-reference/classes-and-functions.md | 0 doc/{html => breathe}/conf.py.in | 0 doc/{html => breathe}/index.md | 0 7 files changed, 25 insertions(+), 22 deletions(-) create mode 100644 doc/CMakeLists.txt rename doc/{html => }/Doxyfile.in (99%) rename doc/{html => breathe}/code-reference/classes-and-functions.md (100%) rename doc/{html => breathe}/conf.py.in (100%) rename doc/{html => breathe}/index.md (100%) diff --git a/CMakeLists.txt b/CMakeLists.txt index 5a56251..46886f3 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -46,6 +46,7 @@ add_subdirectory(src/myx/base) add_subdirectory(src/myx/filesystem) add_subdirectory(src/myx/log) add_subdirectory(src/myx/qt) +add_subdirectory(doc) # Примеры if (BUILD_EXAMPLES) @@ -61,21 +62,3 @@ ExternalProject_Add(whereami CONFIGURE_COMMAND ${CMAKE_COMMAND} -"G${CMAKE_GENERATOR}" -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR} -DBUILD_SHARED_LIBS=OFF -DBUILD_EXAMPLES=OFF ) -add_breathe_target( - TARGET_NAME doc-breathe - SOURCE_DIR ${CMAKE_SOURCE_DIR}/doc/html - DOXY_FILE ${CMAKE_SOURCE_DIR}/doc/html/Doxyfile.in - CONF_FILE ${CMAKE_SOURCE_DIR}/doc/html/conf.py.in - CACHE_DIR ${CMAKE_BINARY_DIR}/_doctrees - BUILD_DIR ${CMAKE_BINARY_DIR}/doc/breathe - HTML_DIR ${CMAKE_BINARY_DIR}/doc/breathe - COMMENT "Documentation in HTML format with Breathe generator" - ) - -add_doxygen_target( - TARGET_NAME doc-doxygen - DOXY_FILE ${CMAKE_SOURCE_DIR}/doc/html/Doxyfile.in - OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/doc - HTML YES - LATEX YES - ) diff --git a/cmake/cmlib b/cmake/cmlib index 0a2d9a4..156d74f 160000 --- a/cmake/cmlib +++ b/cmake/cmlib @@ -1 +1 @@ -Subproject commit 0a2d9a4fceb445843be62247f77da098faf7ba12 +Subproject commit 156d74f581cac0771f3c05411fd0d79f811afc55 diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 0000000..79789f3 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,20 @@ +add_breathe_target( + TARGET_NAME doc-breathe + SOURCE_DIR ${CMAKE_SOURCE_DIR}/doc/breathe + DOXY_FILE ${CMAKE_SOURCE_DIR}/doc/Doxyfile.in + CONF_FILE ${CMAKE_SOURCE_DIR}/doc/breathe/conf.py.in + OUTPUT_DIR ${CMAKE_BINARY_DIR}/doc/breathe + COMMENT "Documentation in HTML format with Breathe generator" + ) + +add_doxygen_target( + TARGET_NAME doc-doxygen + SOURCE_DIR ${CMAKE_SOURCE_DIR}/src + DOXY_FILE ${CMAKE_SOURCE_DIR}/doc/Doxyfile.in + OUTPUT_DIR ${CMAKE_BINARY_DIR}/doc + HTML YES + LATEX YES + COMMENT "Documentation in HTML and LaTeX format with Doxygen" + ) + + diff --git a/doc/html/Doxyfile.in b/doc/Doxyfile.in similarity index 99% rename from doc/html/Doxyfile.in rename to doc/Doxyfile.in index 60291ac..ef33a14 100644 --- a/doc/html/Doxyfile.in +++ b/doc/Doxyfile.in @@ -11,7 +11,7 @@ PROJECT_LOGO = OUTPUT_DIRECTORY = @OUTPUT_DIRECTORY@ CREATE_SUBDIRS = NO ALLOW_UNICODE_NAMES = NO -OUTPUT_LANGUAGE = Russian +OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ABBREVIATE_BRIEF = "The $name class" \ @@ -28,8 +28,8 @@ ABBREVIATE_BRIEF = "The $name class" \ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO FULL_PATH_NAMES = YES -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = +STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src +STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/src SHORT_NAMES = NO JAVADOC_AUTOBRIEF = NO QT_AUTOBRIEF = NO diff --git a/doc/html/code-reference/classes-and-functions.md b/doc/breathe/code-reference/classes-and-functions.md similarity index 100% rename from doc/html/code-reference/classes-and-functions.md rename to doc/breathe/code-reference/classes-and-functions.md diff --git a/doc/html/conf.py.in b/doc/breathe/conf.py.in similarity index 100% rename from doc/html/conf.py.in rename to doc/breathe/conf.py.in diff --git a/doc/html/index.md b/doc/breathe/index.md similarity index 100% rename from doc/html/index.md rename to doc/breathe/index.md