Verified Commit 90dc8e59 authored by SZPYRKA Jean-Luc's avatar SZPYRKA Jean-Luc
Browse files

skeleton nearly achieved

parent f56b5e6d
Pipeline #131196 passed with stage
in 4 minutes and 40 seconds
......@@ -37,18 +37,21 @@ set(${PROJECT_NAME}_VERSION
## Input
## ###################################################################
#set( DTK_LOG_DIRECTORY ${CMAKE_SOURCE_DIR}/../dtk-log)
#set(DTK_WIDGETS_DIRECTORY ${CMAKE_SOURCE_DIR}/../dtk-widgets)
if( TRUE ) ## set to FALSE to do speedup the debug phases
set( DTK_LOG_DIRECTORY ${CMAKE_SOURCE_DIR}/../dtk-log)
set(DTK_WIDGETS_DIRECTORY ${CMAKE_SOURCE_DIR}/../dtk-widgets)
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake")
include(cloning_tools)
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake")
dtk_clone(dtk-core)
dtk_clone(dtk-log)
dtk_clone(dtk-widgets)
include(cloning_tools)
tag_clone("qt.tag" "https://raw.githubusercontent.com/mpaperno/maxLibQt/master/doc/tagfiles/qt.tags")
tag_clone("vtk.tag" "http://www.vtk.org/doc/nightly/vtkNightlyDoc.tag.gz")
dtk_clone(dtk-core)
dtk_clone(dtk-log)
dtk_clone(dtk-widgets)
tag_clone("qt.tag" "https://raw.githubusercontent.com/mpaperno/maxLibQt/master/doc/tagfiles/qt.tags")
tag_clone("vtk.tag" "http://www.vtk.org/doc/nightly/vtkNightlyDoc.tag.gz")
endif()
add_subdirectory(doc)
......
# configured documentation tools and intermediate build results
set(BINARY_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/_build")
set(DOC_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/_build")
find_package(Doxygen REQUIRED)
......@@ -9,30 +9,30 @@ if(NOT SPHINX_EXECUTABLE)
endif()
add_custom_target(doc-website-files
WORKING_DIRECTORY ${BINARY_BUILD_DIR}
COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/source ${BINARY_BUILD_DIR}/source
WORKING_DIRECTORY ${DOC_BUILD_DIR}
COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/source ${DOC_BUILD_DIR}/source
COMMENT "Making build copy of website source files"
)
add_custom_target(doc-website
WORKING_DIRECTORY ${BINARY_BUILD_DIR}
COMMAND ${SPHINX_EXECUTABLE} ${BINARY_BUILD_DIR}/source ${CMAKE_CURRENT_BINARY_DIR}/website
WORKING_DIRECTORY ${DOC_BUILD_DIR}
COMMAND ${SPHINX_EXECUTABLE} ${DOC_BUILD_DIR}/source ${CMAKE_CURRENT_BINARY_DIR}/website
DEPENDS doc-website-files
COMMENT "Building web site with ${SPHINX_EXECUTABLE}"
)
add_custom_target(doc
WORKING_DIRECTORY ${BINARY_BUILD_DIR}
COMMAND ${DOXYGEN_EXECUTABLE} ${BINARY_BUILD_DIR}/Doxyfile
WORKING_DIRECTORY ${DOC_BUILD_DIR}
COMMAND ${DOXYGEN_EXECUTABLE} ${DOC_BUILD_DIR}/Doxyfile
DEPENDS doc-website
COMMENT "Building Doxygen doc")
configure_file(Doxyfile.in
${BINARY_BUILD_DIR}/Doxyfile
${DOC_BUILD_DIR}/Doxyfile
IMMEDIATE @ONLY)
configure_file(css/custom.css
${BINARY_BUILD_DIR}/css/custom.css
${DOC_BUILD_DIR}/css/custom.css
IMMEDIATE @ONLY)
configure_file(source/conf.py.in
${BINARY_BUILD_DIR}/source/conf.py
${DOC_BUILD_DIR}/source/conf.py
IMMEDIATE @ONLY)
......@@ -832,6 +832,7 @@ WARN_LOGFILE =
INPUT = @CMAKE_BINARY_DIR@/dtk-core-prefix/src/dtk-core/src \
@CMAKE_BINARY_DIR@/dtk-log-prefix/src/dtk-log/src \
@CMAKE_BINARY_DIR@/dtk-widgets-prefix/src/dtk-widgets/src
#INPUT = @CMAKE_BINARY_DIR@/dtk-core-prefix/src/dtk-log/src
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
......
//
//
// Example that constructs plugin factory
//
//
......
......@@ -19,7 +19,7 @@
project = "@PROJECT_NAME@"
copyright = "2010-2020, sed-sophia"
author = "sed-sophia@inria.fr"
author = "sed-sam@inria.fr"
# The full version, including alpha/beta/rc tags
release = "${${PROJECT_NAME}_VERSION}"
......@@ -34,12 +34,20 @@ extensions = [ 'recommonmark'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# 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
highlight_language = 'c++'
# -- Options for HTML output -------------------------------------------------
......@@ -53,4 +61,4 @@ html_theme = 'sphinx_rtd_theme'
# 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' , 'media', 'code']
html_static_path = ['@DOC_BUILD_DIR@/source/media', '@DOC_BUILD_DIR@/source/code', '@DOC_BUILD_DIR@/source/examples' ]
Examples
--------
.. toctree::
:maxdepth: 2
:caption: Table of Examples
:name: exampletoc
:hidden:
example/example1
The following examples are provided:
dtkLog
......@@ -20,7 +11,8 @@ dtkLog
dtkCore
^^^^^^^
* `Example 1: <./examples/core/c01_factory.rst>`__ define a plugin factory
* :doc:`Example 1: <examples/core/c01_factory>` define a plugin factory
dtkWidgets
^^^^^^^^^^
......
......@@ -4,7 +4,7 @@ Example 1
Description
"""""""""""
This example explain how to create a plugin factory
This example explain how to create a plugin factory XXX
Tasks performed:
......@@ -16,7 +16,9 @@ Tasks performed:
Code
""""
.. code-block:: c++
.. literalinclude:: ../../code/core/c01_factory.cpp
:language: c++
:linenos:
Download
......
......@@ -11,14 +11,14 @@ You can learn how to
* :doc:`Quick install <./download>`
* :doc:`Compile <./compile>` from sources
* :doc:`Examples <./examples>`
* Use it with :doc:`Examples <./examples>`
You also have access to the `API reference <./doxygen/index.html>`__ (generated by doxygen)
.. toctree::
:maxdepth: 2
:caption: Table of Contents
:name: mastertoc
:maxdepth: 10
about
download
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment