Set up Sphinx to automatically invoke Doxygen if needed

CMakeLists.txt

@@ -39,11 +39,10 @@ endif(WIN32)
 # doxygen
 find_package(Doxygen)
 if(DOXYGEN_FOUND)
-	set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/generated/Doxyfile)
+	set(DOXYGEN_OUT ${CMAKE_CURRENT_SOURCE_DIR}/generated/Doxyfile)
 	set(ICSNEO_DOCS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/docs)
 
-	configure_file(${ICSNEO_DOCS_DIR}/Doxyfile.template ${DOXYGEN_OUT} @ONLY)
-	message("Doxygen build started")
+	message("Will build Doxygen based documentation")
 	
 	add_custom_target(libicsneo_doxygen ALL
 		COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
@@ -55,6 +54,10 @@ if(DOXYGEN_FOUND)
 	# sphinx
 	find_package(Sphinx)
 	if(SPHINX_EXECUTABLE)
+		message("Will build Sphinx based documentation")
+
+		set(SPHINX_OUT ${ICSNEO_DOCS_DIR}/build/sphinx)
+
 		# configured documentation tools and intermediate build results
 		set(SPHINX_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/_build)
 
@@ -66,18 +69,18 @@ if(DOXYGEN_FOUND)
 
 		configure_file(
 			"${ICSNEO_DOCS_DIR}/conf.py.template"
-			"${SPHINX_BUILD_DIR}/conf.py"
+			"${ICSNEO_DOCS_DIR}/conf.py"
 			@ONLY)
 
 		add_custom_target(libicsneo_sphinx ALL
 			${SPHINX_EXECUTABLE}
 				-q -b html
-				-c "${SPHINX_BUILD_DIR}"
+				-c "${ICSNEO_DOCS_DIR}"
 				-d "${SPHINX_CACHE_DIR}"
 				"${ICSNEO_DOCS_DIR}"
 				"${SPHINX_HTML_DIR}"
 			COMMENT "Building HTML documentation with Sphinx"
-			DEPENDS icsneocpp icsneoc icsneolegacy libicsneo_doxygen)
+			DEPENDS icsneocpp icsneoc icsneolegacy)
 	endif()
 endif()
 

docs/Doxyfile

@@ -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       = @CMAKE_CURRENT_BINARY_DIR@/doc_doxygen/
+OUTPUT_DIRECTORY       = docs/build/doxygen
 
 # 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

docs/conf.py

@@ -0,0 +1,188 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# NOTE: The conf.py file is automatically updated by CMake when there are
+# changes to the version. Update the conf.py.template and then build to
+# propagate changes here. This file should be committed so that
+# ReadTheDocs can use it.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import subprocess
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# 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 = ['sphinx.ext.imgmath', 'sphinx.ext.todo', 'breathe' ]
+
+breathe_projects = { "libicsneo": "build/doxygen/xml" }
+breathe_default_project = "libicsneo"
+
+try:
+    os.makedirs('build/sphinx')
+except FileExistsError:
+    pass
+try:
+    os.makedirs('build/doxygen')
+except FileExistsError:
+    pass
+
+subprocess.call('cd ..; doxygen docs/Doxyfile', shell=True)
+
+# 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']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'libicsneo'
+copyright = '2018, Intrepid Control Systems, Inc'
+author = 'Intrepid Control Systems, Inc.'
+
+# 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 = '0.1.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.0 '
+
+# 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 = ['_static']
+
+# 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 = 'libicsneodoc'
+
+
+# -- 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, 'libicsneo.tex', 'libicsneo Documentation',
+     'Intrepid Control Systems, Inc.', '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, 'libicsneo', 'libicsneo 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, 'libicsneo', 'libicsneo Documentation',
+     author, 'libicsneo', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/conf.py.template

@@ -1,8 +1,10 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
-# libicsneo documentation build configuration file, created by
-# sphinx-quickstart on Tue Nov 20 14:25:27 2018.
+# NOTE: The conf.py file is automatically updated by CMake when there are
+# changes to the version. Update the conf.py.template and then build to
+# propagate changes here. This file should be committed so that
+# ReadTheDocs can use it.
 #
 # This file is execfile()d with the current directory set to its
 # containing dir.
@@ -17,7 +19,8 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
+import os
+import subprocess
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
@@ -33,9 +36,20 @@
 # ones.
 extensions = ['sphinx.ext.imgmath', 'sphinx.ext.todo', 'breathe' ]
 
-breathe_projects = { "libicsneo": "@CMAKE_CURRENT_BINARY_DIR@/doc_doxygen/xml/" }
+breathe_projects = { "libicsneo": "build/doxygen/xml" }
 breathe_default_project = "libicsneo"
 
+try:
+    os.makedirs('build/sphinx')
+except FileExistsError:
+    pass
+try:
+    os.makedirs('build/doxygen')
+except FileExistsError:
+    pass
+
+subprocess.call('cd ..; doxygen docs/Doxyfile', shell=True)
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -99,7 +113,7 @@ 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 = ['@SPHINX_HTML_DIR@/_static']
+html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.