Publish and update matfaust GPU wrapper tutorial.

Unrelated change workaround to missing python executable when generating the doc (typically when the build is not configured to build the python wrapper).

Publish and update matfaust GPU wrapper tutorial.
00afcb09 · hhakim · ac503492 · 00afcb09 · 00afcb09 · 00afcb09
Commit 00afcb09 authored 4 years ago by hhakim
--- a/gen_doc/CMakeLists.txt
+++ b/gen_doc/CMakeLists.txt
@@ -61,6 +61,10 @@ if(BUILD_DOCUMENTATION)
        #list(GET <list> <element index> [<index> ...] <out-var>)
        list(GET PYTHON_EXES -1 PY3_EXE)
        set(GLOB_PATTS "'${PROJECT_BINARY_DIR}/doc/html/namespacepyfaust_*.html';'${PROJECT_BINARY_DIR}/doc/html/namespacematfaust_*.html'")
+	if(NOT PY3_EXE)
+		# workaround in case BUILD_WRAPPER_PYTHON is OFF which implies PY3_EXE is not set
+		set(PY3_EXE python3)
+	endif()
        add_custom_target(doc_exclu_class_filtering ALL ${PY3_EXE}
            ${PROJECT_BINARY_DIR}/doc/filterout_excluded_classes.py ${GLOB_PATTS} DEPENDS doc WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Filter out the non-documented classes")
    	if(BUILD_WRAPPER_MATLAB)
@@ -156,6 +160,7 @@ if(BUILD_DOCUMENTATION)
 	configure_file(${FAUST_DOC_SRC_DIR}/Faust_factorization.mlx.html ${PROJECT_BINARY_DIR}/doc/html/Faust_factorization.mlx.html COPYONLY)
 	configure_file(${FAUST_DOC_SRC_DIR}/Use_of_Faust_objects_in_algorithms.mlx ${PROJECT_BINARY_DIR}/doc/html/Use_of_Faust_objects_in_algorithms.mlx COPYONLY)
 	configure_file(${FAUST_DOC_SRC_DIR}/Use_of_Faust_objects_in_algorithms.mlx.html ${PROJECT_BINARY_DIR}/doc/html/Use_of_Faust_objects_in_algorithms.mlx.html COPYONLY)
+	configure_file(${FAUST_DOC_SRC_DIR}/using_gpu_matfaust.html ${PROJECT_BINARY_DIR}/doc/html/using_gpu_matfaust.html COPYONLY)

 	configure_file(${FAUST_DOC_SRC_DIR}/faust_projectors.mlx ${PROJECT_BINARY_DIR}/doc/html/faust_projectors.mlx COPYONLY)
 	configure_file(${FAUST_DOC_SRC_DIR}/faust_projectors.mlx.html ${PROJECT_BINARY_DIR}/doc/html/faust_projectors.mlx.html COPYONLY)

--- a/gen_doc/mainpage_wrappers_inc.md
+++ b/gen_doc/mainpage_wrappers_inc.md
@@ -21,5 +21,6 @@ Besides, if you're more familiar with Matlab, some livescripts are also availabl
 - [Using the FAµST Factorization Wrappers](./Faust_factorization.mlx.html)
 - [Using the FAµST API in Algorithms](./Use_of_Faust_objects_in_algorithms.mlx.html)
 - [Using The FAµST Projectors API](./faust_projectors.mlx.html)
+- [Using the GPU with matfaust](./using_gpu_matfaust.html)

 Download all the livescripts (.mlx) [here](./matfaust_livescripts.zip).
--- a/gen_doc/using_gpu_matfaust.html
+++ b/gen_doc/using_gpu_matfaust.html
@@ -8,6 +8,8 @@
 <body>
 <h1>Using The GPU FAµST API</h1>

+<p><strong>NOTE</strong>: this documentation will be converted to a Matlab Live Script as soon as possible. However, all the content is illustrated with code snippets and outputs as you would find in a Live Script.</p>
+
 <p><strong>Sections in this tutorial:</strong></p>

 <ol>

--- a/gen_doc/using_gpu_matfaust.md
+++ b/gen_doc/using_gpu_matfaust.md
 # Using The GPU FAµST API

+**NOTE**: this documentation will be converted to a Matlab Live Script as soon as possible. However, all the content is illustrated with code snippets and outputs as you would find in a Live Script.
+
 __Sections in this tutorial:__  

 1. <a href="#1" >Creating a GPU Faust object</a>