Автогенерация документации
This commit is contained in:
parent
9432d12c2b
commit
45fb667829
@ -52,13 +52,5 @@ if (BUILD_EXAMPLES)
|
|||||||
add_subdirectory(examples/log)
|
add_subdirectory(examples/log)
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
add_breathe_target(
|
add_subdirectory(doc)
|
||||||
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"
|
|
||||||
)
|
|
||||||
|
@ -1 +1 @@
|
|||||||
Subproject commit 45d7f7054d8228fddc296033e09d698a01d9e0b2
|
Subproject commit 36073091bc042af1ef1f7324d26c503bce3ac148
|
21
cmake/etc/Variables.cmake
Normal file
21
cmake/etc/Variables.cmake
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
set(ORGANIZATION_NAME "rtis")
|
||||||
|
|
||||||
|
set(CPACK_GENERATOR "TXZ;DEB")
|
||||||
|
set(CPACK_PACKAGE_CONTACT "Andrei Astafev <dev@246060.ru>")
|
||||||
|
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$)
|
@ -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$
|
|
@ -1 +0,0 @@
|
|||||||
RTIS
|
|
@ -1 +1 @@
|
|||||||
Subproject commit 862acd75f740e7b1b33734dcbad215c3bb5c4c37
|
Subproject commit af57d3921c4d944f8475090f42b034518f7c0bc7
|
20
doc/CMakeLists.txt
Normal file
20
doc/CMakeLists.txt
Normal file
@ -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"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
@ -8,7 +8,7 @@ PROJECT_NAME = @PROJECT_NAME@
|
|||||||
PROJECT_NUMBER =
|
PROJECT_NUMBER =
|
||||||
PROJECT_BRIEF =
|
PROJECT_BRIEF =
|
||||||
PROJECT_LOGO =
|
PROJECT_LOGO =
|
||||||
OUTPUT_DIRECTORY =
|
OUTPUT_DIRECTORY = @OUTPUT_DIRECTORY@
|
||||||
CREATE_SUBDIRS = NO
|
CREATE_SUBDIRS = NO
|
||||||
ALLOW_UNICODE_NAMES = NO
|
ALLOW_UNICODE_NAMES = NO
|
||||||
OUTPUT_LANGUAGE = Russian
|
OUTPUT_LANGUAGE = Russian
|
||||||
@ -28,8 +28,8 @@ ABBREVIATE_BRIEF = "The $name class" \
|
|||||||
ALWAYS_DETAILED_SEC = NO
|
ALWAYS_DETAILED_SEC = NO
|
||||||
INLINE_INHERITED_MEMB = NO
|
INLINE_INHERITED_MEMB = NO
|
||||||
FULL_PATH_NAMES = YES
|
FULL_PATH_NAMES = YES
|
||||||
STRIP_FROM_PATH =
|
STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src
|
||||||
STRIP_FROM_INC_PATH =
|
STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/src
|
||||||
SHORT_NAMES = NO
|
SHORT_NAMES = NO
|
||||||
JAVADOC_AUTOBRIEF = NO
|
JAVADOC_AUTOBRIEF = NO
|
||||||
QT_AUTOBRIEF = NO
|
QT_AUTOBRIEF = NO
|
||||||
@ -193,7 +193,7 @@ IGNORE_PREFIX =
|
|||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# Configuration options related to the HTML output
|
# Configuration options related to the HTML output
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
GENERATE_HTML = NO
|
GENERATE_HTML = @GENERATE_HTML@
|
||||||
HTML_OUTPUT = html
|
HTML_OUTPUT = html
|
||||||
HTML_FILE_EXTENSION = .html
|
HTML_FILE_EXTENSION = .html
|
||||||
HTML_HEADER =
|
HTML_HEADER =
|
||||||
@ -251,7 +251,7 @@ EXTRA_SEARCH_MAPPINGS =
|
|||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# Configuration options related to the LaTeX output
|
# Configuration options related to the LaTeX output
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
GENERATE_LATEX = NO
|
GENERATE_LATEX = @GENERATE_LATEX@
|
||||||
LATEX_OUTPUT = latex
|
LATEX_OUTPUT = latex
|
||||||
LATEX_CMD_NAME = latex
|
LATEX_CMD_NAME = latex
|
||||||
MAKEINDEX_CMD_NAME = makeindex
|
MAKEINDEX_CMD_NAME = makeindex
|
||||||
@ -290,7 +290,7 @@ MAN_LINKS = NO
|
|||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# Configuration options related to the XML output
|
# Configuration options related to the XML output
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
GENERATE_XML = YES
|
GENERATE_XML = @GENERATE_XML@
|
||||||
XML_OUTPUT = xml
|
XML_OUTPUT = xml
|
||||||
XML_PROGRAMLISTING = YES
|
XML_PROGRAMLISTING = YES
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
@ -344,9 +344,9 @@ DOT_FONTNAME = Helvetica
|
|||||||
DOT_FONTSIZE = 10
|
DOT_FONTSIZE = 10
|
||||||
DOT_FONTPATH =
|
DOT_FONTPATH =
|
||||||
CLASS_GRAPH = YES
|
CLASS_GRAPH = YES
|
||||||
COLLABORATION_GRAPH = YES
|
COLLABORATION_GRAPH = NO
|
||||||
GROUP_GRAPHS = YES
|
GROUP_GRAPHS = YES
|
||||||
UML_LOOK = NO
|
UML_LOOK = YES
|
||||||
UML_LIMIT_NUM_FIELDS = 10
|
UML_LIMIT_NUM_FIELDS = 10
|
||||||
TEMPLATE_RELATIONS = NO
|
TEMPLATE_RELATIONS = NO
|
||||||
INCLUDE_GRAPH = YES
|
INCLUDE_GRAPH = YES
|
@ -158,7 +158,7 @@ texinfo_documents = [
|
|||||||
'One line description of project.', 'Miscellaneous'),
|
'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):
|
def run_doxygen(folder):
|
||||||
@ -174,7 +174,7 @@ def run_doxygen(folder):
|
|||||||
|
|
||||||
|
|
||||||
def setup(app):
|
def setup(app):
|
||||||
run_doxygen('@BREATHE_DOC_BUILD_DIR@')
|
run_doxygen('@BREATHE_DOCS_BUILD_DIR@')
|
||||||
app.add_config_value('recommonmark_config', {
|
app.add_config_value('recommonmark_config', {
|
||||||
'enable_auto_toc_tree': True,
|
'enable_auto_toc_tree': True,
|
||||||
'enable_eval_rst': True,
|
'enable_eval_rst': True,
|
Loading…
Reference in New Issue
Block a user