Mentions légales du service

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

Finish filtering of non-documented classes both for matfaust and pyfaust.

parent b92472b5
No related branches found
No related tags found
No related merge requests found
...@@ -15,8 +15,7 @@ if(BUILD_DOCUMENTATION) ...@@ -15,8 +15,7 @@ if(BUILD_DOCUMENTATION)
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.
configure_file(${FAUST_DOC_SRC_DIR}/py_filterout_namespace.py ${PROJECT_BINARY_DIR}/doc/py_filterout_namespace.py @ONLY) configure_file(${FAUST_DOC_SRC_DIR}/py_filterout_namespace.py ${PROJECT_BINARY_DIR}/doc/py_filterout_namespace.py @ONLY)
configure_file(${FAUST_DOC_SRC_DIR}/filterout_excluded_classes.py configure_file(${FAUST_DOC_SRC_DIR}/filterout_excluded_classes.py ${PROJECT_BINARY_DIR}/doc/filterout_excluded_classes.py @ONLY)
${PROJECT_BINARY_DIR}/doc/filterout_excluded_classes.py @ONLY)
if(UNIX) if(UNIX)
configure_file(${FAUST_DOC_SRC_DIR}/py_filter.sh.in ${PROJECT_BINARY_DIR}/doc/py_filter @ONLY) configure_file(${FAUST_DOC_SRC_DIR}/py_filter.sh.in ${PROJECT_BINARY_DIR}/doc/py_filter @ONLY)
configure_file(${FAUST_DOC_SRC_DIR}/doxymatlab/m2cpp.pl ${PROJECT_BINARY_DIR}/doc/m2cpp @ONLY) configure_file(${FAUST_DOC_SRC_DIR}/doxymatlab/m2cpp.pl ${PROJECT_BINARY_DIR}/doc/m2cpp @ONLY)
...@@ -31,6 +30,11 @@ if(BUILD_DOCUMENTATION) ...@@ -31,6 +30,11 @@ if(BUILD_DOCUMENTATION)
else() 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 WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Generating API documentation with Doxygen" VERBATIM)
endif() endif()
#list(GET <list> <element index> [<index> ...] <out-var>)
list(GET PYTHON_EXES -1 PY3_EXE)
file(GLOB HTML_FILES RELATIVE_PATH ${PROJECT_BINARY_DIR}/doc/html/ ${PROJECT_BINARY_DIR}/doc/html/namespacepyfaust_*.html ${PROJECT_BINARY_DIR}/doc/html/namespacematfaust_*.html)
message(STATUS "HTML_FILES=${HTML_FILES}")
add_custom_target(doc_exclu_class_filtering ALL ${PY3_EXE} ${PROJECT_BINARY_DIR}/doc/filterout_excluded_classes.py ${HTML_FILES} DEPENDS doc WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Filter out the non-documented classes")
#install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION doc/share/doc) #install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION doc/share/doc)
#file(MAKE_DIRECTORY ${FAUST_INSTALL_DOC}) #file(MAKE_DIRECTORY ${FAUST_INSTALL_DOC})
#install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION ${FAUST_INSTALL_DOC} FILE_PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_WRITE GROUP_EXECUTE WORLD_READ WORLD_WRITE WORLD_EXECUTE) #install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION ${FAUST_INSTALL_DOC} FILE_PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_WRITE GROUP_EXECUTE WORLD_READ WORLD_WRITE WORLD_EXECUTE)
......
import shutil
import sys import sys
import re import re
...@@ -18,13 +19,18 @@ This script intends to filter out the doxygen non-documented classes (set in EXC ...@@ -18,13 +19,18 @@ This script intends to filter out the doxygen non-documented classes (set in EXC
in_block_to_del=False in_block_to_del=False
count_in_block_lines = 0 count_in_block_lines = 0
for line in sys.stdin: for file in sys.argv[1:]:
if(in_block_to_del): print("filtering file:", file)
count_in_block_lines -= 1 tmp = open("tmp.html", mode='w')
if(count_in_block_lines <= 0): for line in open(file):
in_block_to_del = False if(in_block_to_del):
elif(re.match('.*class &#160.*"bottom"><b>', line)): count_in_block_lines -= 1
in_block_to_del=True if(count_in_block_lines <= 0):
count_in_block_lines = 2 in_block_to_del = False
else: elif(re.match('.*class &#160.*"bottom"><b>', line)):
print(line, end='') in_block_to_del=True
count_in_block_lines = 2
else:
tmp.write(line)
tmp.close()
shutil.copyfile("tmp.html", file)
...@@ -4,7 +4,4 @@ ...@@ -4,7 +4,4 @@
@PYTHON3_EXE@ -m doxypypy.doxypypy -a -c $* | @PYTHON3_EXE@ \ @PYTHON3_EXE@ -m doxypypy.doxypypy -a -c $* | @PYTHON3_EXE@ \
py_filterout_namespace.py pyfaust.__init__. pyfaust.factparams. pyfaust.demo. \ py_filterout_namespace.py pyfaust.__init__. pyfaust.factparams. pyfaust.demo. \
pyfaust.tools. pyfaust.fact. \ pyfaust.tools. pyfaust.fact. \
pyfaust.factparams.ConstraintMat | @PYTHON3_EXE@ \ pyfaust.factparams.ConstraintMat
filterout_excluded_classes.py
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment