diff --git a/CMakeLists.txt b/CMakeLists.txt index 0d18bb9..b55a9cd 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -52,13 +52,5 @@ if (BUILD_EXAMPLES) add_subdirectory(examples/log) endif() -add_breathe_target( - TARGET_NAME doc-breathe - SOURCE_DIR ${CMAKE_SOURCE_DIR}/doc/html - BUILD_DIR ${CMAKE_BINARY_DIR} - CACHE_DIR ${CMAKE_BINARY_DIR}/_doctrees - HTML_DIR ${CMAKE_BINARY_DIR}/html - DOXY_FILE ${CMAKE_SOURCE_DIR}/doc/html/Doxyfile.in - CONF_FILE ${CMAKE_SOURCE_DIR}/doc/html/conf.py.in - COMMENT "Documentation in HTML format with Breathe generator" - ) +add_subdirectory(doc) + diff --git a/cmake/cmlib b/cmake/cmlib index 45d7f70..3607309 160000 --- a/cmake/cmlib +++ b/cmake/cmlib @@ -1 +1 @@ -Subproject commit 45d7f7054d8228fddc296033e09d698a01d9e0b2 +Subproject commit 36073091bc042af1ef1f7324d26c503bce3ac148 diff --git a/cmake/etc/Variables.cmake b/cmake/etc/Variables.cmake new file mode 100644 index 0000000..6085d4f --- /dev/null +++ b/cmake/etc/Variables.cmake @@ -0,0 +1,21 @@ +set(ORGANIZATION_NAME "rtis") + +set(CPACK_GENERATOR "TXZ;DEB") +set(CPACK_PACKAGE_CONTACT "Andrei Astafev ") +set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "MyX library") +set(CPACK_DEBIAN_PACKAGE_SECTION "misc") +set(CPACK_DEBIAN_PACKAGE_PRIORITY "optional") +set(CPACK_SOURCE_IGNORE_FILES + .git/ + obj.*/ + build + files/var + debian/tmp/ + debian/files + debian/.*\\\\.log$ + debian/.*.substvars + debian/stamp.* + CMakeLists.txt.user + cmake/lib/.git$ + ~$ + \\\\..*\\\\.swp$) diff --git a/cmake/etc/cpack_ignore.txt b/cmake/etc/cpack_ignore.txt deleted file mode 100644 index 41b99a3..0000000 --- a/cmake/etc/cpack_ignore.txt +++ /dev/null @@ -1,14 +0,0 @@ -.pc/ -.git/ -obj.*/ -build -files/var -debian/tmp/ -debian/files -debian/.*\\\\.log$ -debian/.*.substvars -debian/stamp.* -CMakeLists.txt.user -cmake/lib/.git$ -~$ -\\\\..*\\\\.swp$ diff --git a/cmake/etc/organization.txt b/cmake/etc/organization.txt deleted file mode 100644 index 8953648..0000000 --- a/cmake/etc/organization.txt +++ /dev/null @@ -1 +0,0 @@ -RTIS diff --git a/cmake/find b/cmake/find index 862acd7..af57d39 160000 --- a/cmake/find +++ b/cmake/find @@ -1 +1 @@ -Subproject commit 862acd75f740e7b1b33734dcbad215c3bb5c4c37 +Subproject commit af57d3921c4d944f8475090f42b034518f7c0bc7 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 97% rename from doc/html/Doxyfile.in rename to doc/Doxyfile.in index 679470c..904e81d 100644 --- a/doc/html/Doxyfile.in +++ b/doc/Doxyfile.in @@ -8,7 +8,7 @@ PROJECT_NAME = @PROJECT_NAME@ PROJECT_NUMBER = PROJECT_BRIEF = PROJECT_LOGO = -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = @OUTPUT_DIRECTORY@ CREATE_SUBDIRS = NO ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = Russian @@ -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 @@ -193,7 +193,7 @@ IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- -GENERATE_HTML = NO +GENERATE_HTML = @GENERATE_HTML@ HTML_OUTPUT = html HTML_FILE_EXTENSION = .html HTML_HEADER = @@ -251,7 +251,7 @@ EXTRA_SEARCH_MAPPINGS = #--------------------------------------------------------------------------- # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -GENERATE_LATEX = NO +GENERATE_LATEX = @GENERATE_LATEX@ LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex @@ -290,7 +290,7 @@ MAN_LINKS = NO #--------------------------------------------------------------------------- # Configuration options related to the XML output #--------------------------------------------------------------------------- -GENERATE_XML = YES +GENERATE_XML = @GENERATE_XML@ XML_OUTPUT = xml XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- @@ -344,9 +344,9 @@ DOT_FONTNAME = Helvetica DOT_FONTSIZE = 10 DOT_FONTPATH = CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES +COLLABORATION_GRAPH = NO GROUP_GRAPHS = YES -UML_LOOK = NO +UML_LOOK = YES UML_LIMIT_NUM_FIELDS = 10 TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = YES 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 98% rename from doc/html/conf.py.in rename to doc/breathe/conf.py.in index 4cb1b79..994bc3f 100644 --- a/doc/html/conf.py.in +++ b/doc/breathe/conf.py.in @@ -158,7 +158,7 @@ texinfo_documents = [ 'One line description of project.', 'Miscellaneous'), ] -breathe_projects = {'@PROJECT_NAME@': '@BREATHE_DOC_BUILD_DIR@/xml'} +breathe_projects = {'@PROJECT_NAME@': '@BREATHE_DOCS_BUILD_DIR@/xml'} def run_doxygen(folder): @@ -174,7 +174,7 @@ def run_doxygen(folder): def setup(app): - run_doxygen('@BREATHE_DOC_BUILD_DIR@') + run_doxygen('@BREATHE_DOCS_BUILD_DIR@') app.add_config_value('recommonmark_config', { 'enable_auto_toc_tree': True, 'enable_eval_rst': True, 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