From d6854fc9f77cc63d9df5e93f680aa83f8c731c91 Mon Sep 17 00:00:00 2001 From: Andrey Astafyev Date: Thu, 19 Dec 2019 09:49:34 +0300 Subject: [PATCH] =?UTF-8?q?=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=D0=B8=D0=B5=20=D0=BF=D0=BE=D0=B4=D0=BC=D0=BE=D0=B4=D1=83?= =?UTF-8?q?=D0=BB=D0=B5=D0=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitmodules | 3 + CMakeLists.txt | 2 +- cmake/doc | 1 + cmake/etc/Variables.cmake | 8 +- cmake/etc/uncrustify | 2 +- cmake/generators | 2 +- doc/CMakeLists.txt | 20 - doc/Doxyfile.in | 371 ------------------ .../classes-and-functions.md | 2 + doc/breathe/conf.py.in | 185 --------- doc/breathe/index.md | 12 - doc/breathe/index.md.in | 12 + 12 files changed, 28 insertions(+), 592 deletions(-) create mode 160000 cmake/doc delete mode 100644 doc/CMakeLists.txt delete mode 100644 doc/Doxyfile.in rename doc/breathe/{code-reference => }/classes-and-functions.md (94%) delete mode 100644 doc/breathe/conf.py.in delete mode 100644 doc/breathe/index.md create mode 100644 doc/breathe/index.md.in diff --git a/.gitmodules b/.gitmodules index 6c3ddd7..9834bfb 100644 --- a/.gitmodules +++ b/.gitmodules @@ -10,3 +10,6 @@ [submodule "cmake/generators"] path = cmake/generators url = ../../f1x1t/cmake-generators +[submodule "cmake/doc"] + path = cmake/doc + url = ../../f1x1t/cmake-doc diff --git a/CMakeLists.txt b/CMakeLists.txt index 2732240..993ffcd 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -56,5 +56,5 @@ if (BUILD_EXAMPLES) endif() # Документация -add_subdirectory(doc) +add_subdirectory(cmake/doc) diff --git a/cmake/doc b/cmake/doc new file mode 160000 index 0000000..30b457b --- /dev/null +++ b/cmake/doc @@ -0,0 +1 @@ +Subproject commit 30b457bbc4b0948e78556507336f455547384ab6 diff --git a/cmake/etc/Variables.cmake b/cmake/etc/Variables.cmake index 6085d4f..62e03f9 100644 --- a/cmake/etc/Variables.cmake +++ b/cmake/etc/Variables.cmake @@ -1,4 +1,10 @@ -set(ORGANIZATION_NAME "rtis") +set(ORGANIZATION_NAME "RTIS") +set(AUTHOR_NAME "Андрей Астафьев") + +set(DOXYGEN_PROJECT_TITLE "MyXLib") +set(DOXYGEN_GENERATE_LATEX YES) +set(DOXYGEN_GENERATE_HTML YES) +set(DOXYGEN_GENERATE_SQLITE YES) set(CPACK_GENERATOR "TXZ;DEB") set(CPACK_PACKAGE_CONTACT "Andrei Astafev ") diff --git a/cmake/etc/uncrustify b/cmake/etc/uncrustify index 2c51ecc..45284f9 160000 --- a/cmake/etc/uncrustify +++ b/cmake/etc/uncrustify @@ -1 +1 @@ -Subproject commit 2c51ecc3dc681b11a6283d8ab64e6410f8b11678 +Subproject commit 45284f97623b7ae952020771846ccfe2e0a3cf58 diff --git a/cmake/generators b/cmake/generators index 9952d86..c04395e 160000 --- a/cmake/generators +++ b/cmake/generators @@ -1 +1 @@ -Subproject commit 9952d8626933a1003f90395a90946934dd254f48 +Subproject commit c04395ef98c3973caf41a67de8263018d82c6c5e diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt deleted file mode 100644 index 79789f3..0000000 --- a/doc/CMakeLists.txt +++ /dev/null @@ -1,20 +0,0 @@ -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/Doxyfile.in b/doc/Doxyfile.in deleted file mode 100644 index 904e81d..0000000 --- a/doc/Doxyfile.in +++ /dev/null @@ -1,371 +0,0 @@ -# Doxyfile 1.8.14 - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- -DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = @PROJECT_NAME@ -PROJECT_NUMBER = -PROJECT_BRIEF = -PROJECT_LOGO = -OUTPUT_DIRECTORY = @OUTPUT_DIRECTORY@ -CREATE_SUBDIRS = NO -ALLOW_UNICODE_NAMES = NO -OUTPUT_LANGUAGE = Russian -BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the -ALWAYS_DETAILED_SEC = NO -INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = YES -STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src -STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/src -SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = NO -QT_AUTOBRIEF = NO -MULTILINE_CPP_IS_BRIEF = NO -INHERIT_DOCS = YES -SEPARATE_MEMBER_PAGES = NO -TAB_SIZE = 4 -ALIASES = -TCL_SUBST = -OPTIMIZE_OUTPUT_FOR_C = NO -OPTIMIZE_OUTPUT_JAVA = NO -OPTIMIZE_FOR_FORTRAN = NO -OPTIMIZE_OUTPUT_VHDL = NO -EXTENSION_MAPPING = -MARKDOWN_SUPPORT = YES -AUTOLINK_SUPPORT = YES -BUILTIN_STL_SUPPORT = NO -CPP_CLI_SUPPORT = NO -SIP_SUPPORT = NO -IDL_PROPERTY_SUPPORT = YES -DISTRIBUTE_GROUP_DOC = NO -GROUP_NESTED_COMPOUNDS = NO -SUBGROUPING = YES -INLINE_GROUPED_CLASSES = NO -INLINE_SIMPLE_STRUCTS = NO -TYPEDEF_HIDES_STRUCT = NO -LOOKUP_CACHE_SIZE = 0 -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- -EXTRACT_ALL = NO -EXTRACT_PRIVATE = YES -EXTRACT_PACKAGE = NO -EXTRACT_STATIC = YES -EXTRACT_LOCAL_CLASSES = YES -EXTRACT_LOCAL_METHODS = NO -EXTRACT_ANON_NSPACES = NO -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO -HIDE_FRIEND_COMPOUNDS = NO -HIDE_IN_BODY_DOCS = NO -INTERNAL_DOCS = NO -CASE_SENSE_NAMES = NO -HIDE_SCOPE_NAMES = NO -HIDE_COMPOUND_REFERENCE= NO -SHOW_INCLUDE_FILES = YES -SHOW_GROUPED_MEMB_INC = NO -FORCE_LOCAL_INCLUDES = NO -INLINE_INFO = YES -SORT_MEMBER_DOCS = YES -SORT_BRIEF_DOCS = NO -SORT_MEMBERS_CTORS_1ST = NO -SORT_GROUP_NAMES = NO -SORT_BY_SCOPE_NAME = NO -STRICT_PROTO_MATCHING = NO -GENERATE_TODOLIST = YES -GENERATE_TESTLIST = YES -GENERATE_BUGLIST = YES -GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = -MAX_INITIALIZER_LINES = 30 -SHOW_USED_FILES = YES -SHOW_FILES = YES -SHOW_NAMESPACES = YES -FILE_VERSION_FILTER = -LAYOUT_FILE = -CITE_BIB_FILES = -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -QUIET = NO -WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES -WARN_IF_DOC_ERROR = YES -WARN_NO_PARAMDOC = NO -WARN_AS_ERROR = NO -WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- -INPUT = @PROJECT_SOURCE_DIR@/src \ - @PROJECT_SOURCE_DIR@/doc/html -INPUT_ENCODING = UTF-8 -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.pyw \ - *.f90 \ - *.f95 \ - *.f03 \ - *.f08 \ - *.f \ - *.for \ - *.tcl \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf -RECURSIVE = YES -EXCLUDE = -EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = -EXCLUDE_SYMBOLS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = * -EXAMPLE_RECURSIVE = NO -IMAGE_PATH = -INPUT_FILTER = -FILTER_PATTERNS = -FILTER_SOURCE_FILES = NO -FILTER_SOURCE_PATTERNS = -USE_MDFILE_AS_MAINPAGE = -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- -SOURCE_BROWSER = NO -INLINE_SOURCES = NO -STRIP_CODE_COMMENTS = YES -REFERENCED_BY_RELATION = NO -REFERENCES_RELATION = NO -REFERENCES_LINK_SOURCE = YES -SOURCE_TOOLTIPS = YES -USE_HTAGS = NO -VERBATIM_HEADERS = YES -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = YES -COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- -GENERATE_HTML = @GENERATE_HTML@ -HTML_OUTPUT = html -HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = -HTML_EXTRA_STYLESHEET = -HTML_EXTRA_FILES = -HTML_COLORSTYLE_HUE = 220 -HTML_COLORSTYLE_SAT = 100 -HTML_COLORSTYLE_GAMMA = 80 -HTML_TIMESTAMP = NO -HTML_DYNAMIC_SECTIONS = NO -HTML_INDEX_NUM_ENTRIES = 100 -GENERATE_DOCSET = NO -DOCSET_FEEDNAME = "Doxygen generated docs" -DOCSET_BUNDLE_ID = org.doxygen.Project -DOCSET_PUBLISHER_ID = org.doxygen.Publisher -DOCSET_PUBLISHER_NAME = Publisher -GENERATE_HTMLHELP = NO -CHM_FILE = -HHC_LOCATION = -GENERATE_CHI = NO -CHM_INDEX_ENCODING = -BINARY_TOC = NO -TOC_EXPAND = NO -GENERATE_QHP = NO -QCH_FILE = -QHP_NAMESPACE = org.doxygen.Project -QHP_VIRTUAL_FOLDER = doc -QHP_CUST_FILTER_NAME = -QHP_CUST_FILTER_ATTRS = -QHP_SECT_FILTER_ATTRS = -QHG_LOCATION = -GENERATE_ECLIPSEHELP = NO -ECLIPSE_DOC_ID = org.doxygen.Project -DISABLE_INDEX = NO -GENERATE_TREEVIEW = YES -ENUM_VALUES_PER_LINE = 4 -TREEVIEW_WIDTH = 250 -EXT_LINKS_IN_WINDOW = NO -FORMULA_FONTSIZE = 10 -FORMULA_TRANSPARENT = YES -USE_MATHJAX = NO -MATHJAX_FORMAT = HTML-CSS -MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/ -MATHJAX_EXTENSIONS = -MATHJAX_CODEFILE = -SEARCHENGINE = YES -SERVER_BASED_SEARCH = NO -EXTERNAL_SEARCH = NO -SEARCHENGINE_URL = -SEARCHDATA_FILE = searchdata.xml -EXTERNAL_SEARCH_ID = -EXTRA_SEARCH_MAPPINGS = -#--------------------------------------------------------------------------- -# Configuration options related to the LaTeX output -#--------------------------------------------------------------------------- -GENERATE_LATEX = @GENERATE_LATEX@ -LATEX_OUTPUT = latex -LATEX_CMD_NAME = latex -MAKEINDEX_CMD_NAME = makeindex -COMPACT_LATEX = NO -PAPER_TYPE = a4 -EXTRA_PACKAGES = -LATEX_HEADER = -LATEX_FOOTER = -LATEX_EXTRA_STYLESHEET = -LATEX_EXTRA_FILES = -PDF_HYPERLINKS = YES -USE_PDFLATEX = YES -LATEX_BATCHMODE = NO -LATEX_HIDE_INDICES = NO -LATEX_SOURCE_CODE = NO -LATEX_BIB_STYLE = plain -LATEX_TIMESTAMP = NO -#--------------------------------------------------------------------------- -# Configuration options related to the RTF output -#--------------------------------------------------------------------------- -GENERATE_RTF = NO -RTF_OUTPUT = rtf -COMPACT_RTF = NO -RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = -RTF_SOURCE_CODE = NO -#--------------------------------------------------------------------------- -# Configuration options related to the man page output -#--------------------------------------------------------------------------- -GENERATE_MAN = NO -MAN_OUTPUT = man -MAN_EXTENSION = .3 -MAN_SUBDIR = -MAN_LINKS = NO -#--------------------------------------------------------------------------- -# Configuration options related to the XML output -#--------------------------------------------------------------------------- -GENERATE_XML = @GENERATE_XML@ -XML_OUTPUT = xml -XML_PROGRAMLISTING = YES -#--------------------------------------------------------------------------- -# Configuration options related to the DOCBOOK output -#--------------------------------------------------------------------------- -GENERATE_DOCBOOK = NO -DOCBOOK_OUTPUT = docbook -DOCBOOK_PROGRAMLISTING = NO -#--------------------------------------------------------------------------- -# Configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- -GENERATE_AUTOGEN_DEF = NO -#--------------------------------------------------------------------------- -# Configuration options related to the Perl module output -#--------------------------------------------------------------------------- -GENERATE_PERLMOD = NO -PERLMOD_LATEX = NO -PERLMOD_PRETTY = YES -PERLMOD_MAKEVAR_PREFIX = -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- -ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = NO -EXPAND_ONLY_PREDEF = NO -SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = -SKIP_FUNCTION_MACROS = YES -#--------------------------------------------------------------------------- -# Configuration options related to external references -#--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = -ALLEXTERNALS = NO -EXTERNAL_GROUPS = YES -EXTERNAL_PAGES = YES -PERL_PATH = @PERL_EXECUTABLE@ -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- -CLASS_DIAGRAMS = NO -MSCGEN_PATH = -DIA_PATH = -HIDE_UNDOC_RELATIONS = YES -HAVE_DOT = YES -DOT_NUM_THREADS = 0 -DOT_FONTNAME = Helvetica -DOT_FONTSIZE = 10 -DOT_FONTPATH = -CLASS_GRAPH = YES -COLLABORATION_GRAPH = NO -GROUP_GRAPHS = YES -UML_LOOK = YES -UML_LIMIT_NUM_FIELDS = 10 -TEMPLATE_RELATIONS = NO -INCLUDE_GRAPH = YES -INCLUDED_BY_GRAPH = YES -CALL_GRAPH = YES -CALLER_GRAPH = YES -GRAPHICAL_HIERARCHY = YES -DIRECTORY_GRAPH = YES -DOT_IMAGE_FORMAT = png -INTERACTIVE_SVG = NO -DOT_PATH = @DOXYGEN_DOT_PATH@ -DOTFILE_DIRS = -MSCFILE_DIRS = -DIAFILE_DIRS = -PLANTUML_JAR_PATH = -PLANTUML_INCLUDE_PATH = -DOT_GRAPH_MAX_NODES = 50 -MAX_DOT_GRAPH_DEPTH = 0 -DOT_TRANSPARENT = NO -DOT_MULTI_TARGETS = NO -GENERATE_LEGEND = YES -DOT_CLEANUP = YES diff --git a/doc/breathe/code-reference/classes-and-functions.md b/doc/breathe/classes-and-functions.md similarity index 94% rename from doc/breathe/code-reference/classes-and-functions.md rename to doc/breathe/classes-and-functions.md index bc4842f..bf449c6 100644 --- a/doc/breathe/code-reference/classes-and-functions.md +++ b/doc/breathe/classes-and-functions.md @@ -1,2 +1,4 @@ # Классы и функции + + diff --git a/doc/breathe/conf.py.in b/doc/breathe/conf.py.in deleted file mode 100644 index 994bc3f..0000000 --- a/doc/breathe/conf.py.in +++ /dev/null @@ -1,185 +0,0 @@ -#!@PYTHON_EXECUTABLE@ -# -*- coding: utf-8 -*- -# - -import os -import subprocess -import sys - -# -- General configuration ------------------------------------------------ - -# At top on conf.py (with other import statements) -import recommonmark -from recommonmark.parser import CommonMarkParser -from recommonmark.transform import AutoStructify -from recommonmark.states import DummyStateMachine -# Monkey patch to fix recommonmark 0.4 doc reference issues. -orig_run_role = DummyStateMachine.run_role -def run_role(self, name, options=None, content=None): - if name == 'doc': - name = 'any' - return orig_run_role(self, name, options, content) -DummyStateMachine.run_role = run_role - -source_parsers = { - '.md': CommonMarkParser -} - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'breathe', 'sphinx.ext.autosectionlabel', 'recommonmark' -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -source_suffix = ['.rst', '.md'] - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = '@PROJECT_NAME@' -author = 'Andrei Astafev' -copyright = '2019, ' + author - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '' -# The full version, including alpha/beta/rc tags. -release = '' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'sphinx_rtd_theme' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = [] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# This is required for the alabaster theme -# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars -html_sidebars = { - '**': [ - 'relations.html', # needs 'show_related': True theme option to display - 'searchbox.html', - ] -} - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. -htmlhelp_basename = '@PROJECT_NAME@doc' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, '@PROJECT_NAME@.tex', '@PROJECT_NAME@ Documentation', - author, 'manual'), -] - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [(master_doc, '@PROJECT_NAME@', '@PROJECT_NAME@ Documentation', [author], 1)] - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, '@PROJECT_NAME@', '@PROJECT_NAME@ Documentation', author, '@PROJECT_NAME@', - 'One line description of project.', 'Miscellaneous'), -] - -breathe_projects = {'@PROJECT_NAME@': '@BREATHE_DOCS_BUILD_DIR@/xml'} - - -def run_doxygen(folder): - """Run the doxygen make command in the designated folder""" - - try: - retcode = subprocess.call("cd {}; doxygen".format(folder), shell=True) - if retcode < 0: - sys.stderr.write( - "doxygen terminated by signal {}".format(-retcode)) - except OSError as e: - sys.stderr.write("doxygen execution failed: {}".format(e)) - - -def setup(app): - run_doxygen('@BREATHE_DOCS_BUILD_DIR@') - app.add_config_value('recommonmark_config', { - 'enable_auto_toc_tree': True, - 'enable_eval_rst': True, - 'enable_auto_doc_ref': True, - 'enable_math': True, - 'enable_inline_math': True - }, True) - app.add_transform(AutoStructify) diff --git a/doc/breathe/index.md b/doc/breathe/index.md deleted file mode 100644 index 97a748e..0000000 --- a/doc/breathe/index.md +++ /dev/null @@ -1,12 +0,0 @@ -# Документация для проекта MyXLib - -## Содержание - -* [Классы и функции](code-reference/classes-and-functions.md) - -## Указатели и таблицы - -```eval_rst -* :ref:`genindex` -``` - diff --git a/doc/breathe/index.md.in b/doc/breathe/index.md.in new file mode 100644 index 0000000..dcd5a8c --- /dev/null +++ b/doc/breathe/index.md.in @@ -0,0 +1,12 @@ +# Документация для проекта @DOXYGEN_PROJECT_TITLE@ + +## Содержание + +* [Классы и функции](classes-and-functions.md) + +## Указатели и таблицы + +```eval_rst +* :ref:`genindex` +``` +