Mentions légales du service

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

Add FaustPy doxygen doc. generation.

Doxypypy package needs to be installed for that generation to work.
The commit also disables the call graph generation (maybe just temporarly as a workaround of python specific issue).
parent 39950dc4
Branches
Tags
No related merge requests found
...@@ -5,6 +5,11 @@ if(BUILD_DOCUMENTATION) ...@@ -5,6 +5,11 @@ if(BUILD_DOCUMENTATION)
if(DOXYGEN_FOUND) if(DOXYGEN_FOUND)
configure_file(${FAUST_DOC_SRC_DIR}/Doxyfile.in ${PROJECT_BINARY_DIR}/doc/Doxyfile @ONLY) configure_file(${FAUST_DOC_SRC_DIR}/Doxyfile.in ${PROJECT_BINARY_DIR}/doc/Doxyfile @ONLY)
# ./gen_doc/images/* files is duplicated in doc/html/ to call images documentation in the source code with relative path of image's files, from build directory. # ./gen_doc/images/* files is duplicated in doc/html/ to call images documentation in the source code with relative path of image's files, from build directory.
if(UNIX)
configure_file(${FAUST_DOC_SRC_DIR}/py_filter.sh.in ${PROJECT_BINARY_DIR}/doc/py_filter @ONLY)
elseif(WIN32)
configure_file(${FAUST_DOC_SRC_DIR}/py_filter.bat.in ${PROJECT_BINARY_DIR}/doc/py_filter.bat @ONLY)
endif()
file(COPY ${FAUST_DOC_SRC_DIR}/images/ DESTINATION ${PROJECT_BINARY_DIR}/doc/html/ ) file(COPY ${FAUST_DOC_SRC_DIR}/images/ DESTINATION ${PROJECT_BINARY_DIR}/doc/html/ )
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) 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)
#install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION doc/share/doc) #install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION doc/share/doc)
......
...@@ -461,8 +461,8 @@ INPUT = "@FAUST_DOC_SRC_DIR@/mainpage.md" \ ...@@ -461,8 +461,8 @@ INPUT = "@FAUST_DOC_SRC_DIR@/mainpage.md" \
"@FAUST_ALGORITHM_CONSTRAINT_SRC_DIR@" \ "@FAUST_ALGORITHM_CONSTRAINT_SRC_DIR@" \
"@FAUST_ALGORITHM_FACTORIZATION_SRC_DIR@" \ "@FAUST_ALGORITHM_FACTORIZATION_SRC_DIR@" \
"@FAUST_BIN_CMDLINE_SRC_DIR@" \ "@FAUST_BIN_CMDLINE_SRC_DIR@" \
"@FAUST_BIN_TEST_SRC_DIR@" "@FAUST_BIN_TEST_SRC_DIR@" \
"@FAUST_PYTHON_SRC_DIR@"
USE_MDFILE_AS_MAINPAGE = mainpage USE_MDFILE_AS_MAINPAGE = mainpage
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
...@@ -491,7 +491,8 @@ FILE_PATTERNS = *.cpp \ ...@@ -491,7 +491,8 @@ FILE_PATTERNS = *.cpp \
*.hpp \ *.hpp \
*.h \ *.h \
*.cu \ *.cu \
*.hu *.hu \
FaustPy.py
# The RECURSIVE tag can be used to turn specify whether or not subdirectories # The RECURSIVE tag can be used to turn specify whether or not subdirectories
...@@ -563,7 +564,7 @@ INPUT_FILTER = ...@@ -563,7 +564,7 @@ INPUT_FILTER =
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
# is applied to all files. # is applied to all files.
FILTER_PATTERNS = FILTER_PATTERNS = *.py=@FAUST_DOC_BIN_DIR@/py_filter
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source # INPUT_FILTER) will be used to filter the input files when producing source
...@@ -1166,7 +1167,7 @@ INCLUDED_BY_GRAPH = YES ...@@ -1166,7 +1167,7 @@ INCLUDED_BY_GRAPH = YES
# So in most cases it will be better to enable call graphs for selected # So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command. # functions only using the \callgraph command.
CALL_GRAPH = YES CALL_GRAPH = NO
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one. # will graphical hierarchy of all classes instead of a textual one.
......
@PYTHON_EXECUTABLE@ -m doxypypy.doxypypy -a -c %1
#!/bin/bash
@PYTHON_EXECUTABLE@ -m doxypypy.doxypypy -a -c $1
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment