Mentions légales du service

Skip to content
Snippets Groups Projects
Commit a312f720 authored by hhakim's avatar hhakim
Browse files

Add matfaust first livescript (Faust creation), update the doxygen website...

Add matfaust first livescript (Faust creation), update the doxygen website markdown to publish it and the cmake script to make the zip archive (as it is already for jupyter notebooks).
parent 199f11c9
No related branches found
No related tags found
No related merge requests found
function (archive_tutos faust_pkg tuto_type file_ext)
# Creates a zip archive of notebooks/livescripts
#example 1: archive_tutos(pyfaust notebook ipynb)
#example 2: archive_tutos(matfaust livescript mlx)
#TODO: rename variable IPYNB_FILES etc
if(UNIX)
file(GLOB IPYNB_FILES "${FAUST_DOC_SRC_DIR}" "*.${file_ext}")
foreach(NB IN LISTS IPYNB_FILES)
get_filename_component(NB ${NB} NAME)
#message(STATUS ${NB})
if(${NB} MATCHES ".*[.]${file_ext}")
set(IPYNB_ZIP_ARG ${IPYNB_ZIP_ARG};${NB})
endif()
endforeach()
add_custom_target(zip_${tuto_type}s ALL zip ${faust_pkg}_${tuto_type}s.zip -b ${PROJECT_BINARY_DIR}/doc/html ${IPYNB_ZIP_ARG} WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc/html COMMENT "Archiving the ${tuto_type}s in a zip file" VERBATIM)
endif(UNIX)
endfunction()
##Generation of the documentation using doxygen
# add a target to generate API documentation with Doxygen
if(BUILD_DOCUMENTATION)
......@@ -29,7 +47,7 @@ if(BUILD_DOCUMENTATION)
if(WIN32)
add_custom_target(doc ALL ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/doc/Doxyfile WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Generating API documentation with Doxygen" VERBATIM)
else()
add_custom_target(doc ALL ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/doc/Doxyfile DEPENDS zip_notebooks WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Generating API documentation with Doxygen" VERBATIM)
add_custom_target(doc ALL ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/doc/Doxyfile DEPENDS zip_notebooks zip_livescripts WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Generating API documentation with Doxygen" VERBATIM)
if(BUILD_WRAPPER_MATLAB)
add_dependencies(doc PREPARE_MATFAUST_FOR_DOXYDOC)
endif()
......@@ -105,6 +123,7 @@ if(BUILD_DOCUMENTATION)
file(REMOVE ${PROJECT_BINARY_DIR}/doc/README_install_part.html)
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/README_template.md ${PROJECT_BINARY_DIR}/doc/README.md)
configure_file(${FAUST_DOC_SRC_DIR}/faq.md ${PROJECT_BINARY_DIR}/doc/faq.md)
# pyfaust jupyter notebooks (ipynb and html)
configure_file(${FAUST_DOC_SRC_DIR}/Faust_creation.ipynb ${PROJECT_BINARY_DIR}/doc/html/Faust_creation.ipynb COPYONLY)
configure_file(${FAUST_DOC_SRC_DIR}/Faust_creation.html ${PROJECT_BINARY_DIR}/doc/html/Faust_creation.html COPYONLY)
configure_file(${FAUST_DOC_SRC_DIR}/Faust_manipulation.ipynb ${PROJECT_BINARY_DIR}/doc/html/Faust_manipulation.ipynb COPYONLY)
......@@ -115,22 +134,12 @@ if(BUILD_DOCUMENTATION)
configure_file(${FAUST_DOC_SRC_DIR}/Use_of_Faust_objects_in_algorithms.html ${PROJECT_BINARY_DIR}/doc/html/Use_of_Faust_objects_in_algorithms.html COPYONLY)
configure_file(${FAUST_DOC_SRC_DIR}/faust_projectors.ipynb ${PROJECT_BINARY_DIR}/doc/html/faust_projectors.ipynb COPYONLY)
configure_file(${FAUST_DOC_SRC_DIR}/faust_projectors.html ${PROJECT_BINARY_DIR}/doc/html/faust_projectors.html COPYONLY)
# matfaust matlab livescripts (mlx and html)
configure_file(${FAUST_DOC_SRC_DIR}/Faust_creation.mlx ${PROJECT_BINARY_DIR}/doc/html/Faust_creation.mlx COPYONLY)
configure_file(${FAUST_DOC_SRC_DIR}/Faust_creation.mlx.html ${PROJECT_BINARY_DIR}/doc/html/Faust_creation.mlx.html COPYONLY)
configure_file(${FAUST_SRC_TEST_SRC_PYTHON_DIR}/test_svd_rc_vs_err.py ${PROJECT_BINARY_DIR}/doc/html/test_svd_rc_vs_err.py COPYONLY)
# create a zip archive for the notebooks
if(UNIX)
file(GLOB IPYNB_FILES "${FAUST_DOC_SRC_DIR}" "*.ipynb")
#message(STATUS "IPYNB_FILES=${IPYNB_FILES}")
foreach(NB IN LISTS IPYNB_FILES)
get_filename_component(NB ${NB} NAME)
#message(STATUS ${NB})
if(${NB} MATCHES ".*[.]ipynb")
set(IPYNB_ZIP_ARG ${IPYNB_ZIP_ARG};${NB})
endif()
endforeach()
#message(STATUS "IPYNB_ZIP_ARG=${IPYNB_ZIP_ARG}")
# set(IPYNB_ZIP_ARG Faust_creation.ipynb Faust_factorization.ipynb Faust_manipulation.ipynb Use_of_Faust_objects_in_algorithms.ipynb)
add_custom_target(zip_notebooks ALL zip pyfaust_notebooks.zip -b ${PROJECT_BINARY_DIR}/doc/html ${IPYNB_ZIP_ARG} WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc/html COMMENT "Archiving the notebook in a zip file" VERBATIM)
endif(UNIX)
archive_tutos(pyfaust notebook ipynb)
archive_tutos(matfaust livescript mlx)
# filter out the HTML tags in pyfaust doc strings
add_custom_target(filter_html_tag_in_pyfaust ALL ${PYTHON3_EXE} ${FAUST_DOC_SRC_DIR}/post_docgen_html_tags_filter.py ${FAUST_PYTHON_BIN_DIR}/pyfaust WORKING_DIRECTORY ${PROJECT_BINARY_DIR} COMMENT "Filtering out HTML tags from pyfaust modules" VERBATIM)
endif(BUILD_DOCUMENTATION)
......
File added
This diff is collapsed.
......@@ -5,9 +5,15 @@ This documentation details the [API](annotated.html) of those frontends (a.k.a.
Please refer to this [README](./md_README.html) for a quick guide on how to install and use FAµST wrappers.
You might also be interested in this introduction to pyfaust through Jupyter Notebook:
- [How to Create a Faust](./Faust_creation.html)
- [How to Manipulate a Faust](./Faust_manipulation.html)
- [Using the FAµST API in Algorithms](./Use_of_Faust_objects_in_algorithms.html)
- [How to Create a Faust](./Faust_creation.html)
- [How to Manipulate a Faust](./Faust_manipulation.html)
- [Using the FAµST API in Algorithms](./Use_of_Faust_objects_in_algorithms.html)
- [Using The FAµST Projectors API](./faust_projectors.html)
Download all the notebooks (.ipynb) [here](./pyfaust_notebooks.zip).
Besides, if you're more familiar with Matlab, some livescripts are also available to introduce matfaust.
- [How to Create a Faust](./Faust_creation.mlx.html)
Download all the livescripts (.mlx) [here](./matfaust_livescripts.zip).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment