doc_makeall.cmake
Go to the documentation of this file.
1 # -------------------------------------------------------------------------
2 # Doxygen documentation batch
3 # -------------------------------------------------------------------------
4 
5 set(DOXYGEN "/builds/gitlab-kitware-sciviz-ci/.gitlab/doxygen/bin/doxygen")
6 set(DOXYGEN_DOT_EXECUTABLE "/usr/bin/dot")
7 set(HTML_HELP_COMPILER "")
8 set(PERL "/usr/bin/perl")
9 set(DOXYGEN_KEEP_TEMP "")
10 
11 if(NOT DOXYGEN)
12  message(FATAL_ERROR "error: cannot build ParaView documentation without doxygen")
13 endif()
14 if(NOT DOXYGEN_DOT_EXECUTABLE)
15  message(FATAL_ERROR "error: cannot build ParaView documentation without dot")
16 endif()
17 if(NOT PERL)
18  message(FATAL_ERROR "error: cannot build ParaView documentation without perl")
19 endif()
20 
21 # PROJECT_NAME:
22 # Documentation/project name. Used in some of the resulting file names and
23 # xrefs to uniquify two or more projects linked together through their
24 # Doxygen's tag files. Mandatory for each documentation set.
25 # Note: might be the same as the doxyfile's PROJECT_NAME
26 # Example:
27 # PROJECT_NAME=ParaView
28 #
29 set (PROJECT_NAME ParaView)
30 
31 # PATH_TO_VTK_DOX_SCRIPTS:
32 # Path to the directory holding the Perl scripts used to produce the VTK doc
33 # in Doxygen format. You need the VTK source files or a local copy of
34 # these scripts.
35 # Example:
36 # PATH_TO_VTK_DOX_SCRIPTS=/builds/gitlab-kitware-sciviz-ci/Utilities/Doxygen
37 #
38 set(PATH_TO_VTK_DOX_SCRIPTS "/builds/gitlab-kitware-sciviz-ci/VTK/Utilities/Doxygen")
39 set(PATH_TO_PARAVIEW_DOX_SCRIPTS "/builds/gitlab-kitware-sciviz-ci/Utilities/Doxygen")
40 
41 # SOURCE_DIR:
42 # Source directory. The top directory of the source files.
43 # Example:
44 # SOURCE_DIR=/builds/gitlab-kitware-sciviz-ci
45 #
46 set(SOURCE_DIR "/builds/gitlab-kitware-sciviz-ci")
47 
48 # REL_PATH_TO_TOP:
49 # Relative path from the top directory of the source files to the directory
50 # (or top directory) holding the files to document. Useful if several parts
51 # of the same source directory should be documented separately.
52 # Example:
53 # REL_PATH_TO_TOP=.
54 # REL_PATH_TO_TOP=framework/src
55 set(REL_PATH_TO_TOP .)
56 
57 # INTERMEDIATE_DOX_DIR:
58 # Directory where the intermediate Doxygen files should be stored (mainly
59 # these headers files converted from the VTK format to the Doxygen format).
60 # This directory is erased at the end of this script, unless you comment
61 # the corresponding line.
62 # DOXTEMP might be used to simplify the syntax.
63 # Example:
64 # DOXTEMP=DOXTEMP=/builds/gitlab-kitware-sciviz-ci/build/Utilities/Doxygen
65 # INTERMEDIATE_DOX_DIR=$DOXTEMP/dox
66 #
67 set(DOXTEMP "/builds/gitlab-kitware-sciviz-ci/build/Utilities/Doxygen")
68 set(INTERMEDIATE_DOX_DIR "${DOXTEMP}/dox")
69 
70 # DATA_ROOT:
71 # Data directory. The root directory of the data files.
72 # Example:
73 # DATA_ROOT=
74 #
75 set(DATA_ROOT "")
76 
77 # GITWEB, GITWEB_SUFFIX, GITWEB_CHECKOUT,
78 # GITWEB_DATA, GITWEB_DATA_SUFFIX, GITWEB_DATA_CHECKOUT:
79 # URL to the GITWeb of the project + same in checkout mode (i.e. appending a
80 # file name to this URL will retrieve the contents of the file). In the same way
81 # GITWEB_SUFFIX will be appended to the result.
82 # Same applies to GITWEB_DATA, which is the URL to the GITWeb
83 # of the Data's project.
84 # Example:
85 # GITWEB=http://public.kitware.com/cgi-bin/viewcvs.cgi
86 # GITWEB_SUFFIX=?root=VTK
87 # GITWEB_CHECKOUT=http://public.kitware.com/cgi-bin/viewcvs.cgi/*checkout*
88 # GITWEB_DATA=http://public.kitware.com/cgi-bin/viewcvs.cgi
89 # GITWEB_DATA_SUFFIX=?root=VTKData
90 # GITWEB_DATA_CHECKOUT=http://public.kitware.com/cgi-bin/viewcvs.cgi/*checkout*
91 #
92 set(GITWEB http://paraview.org/gitweb) # not used
93 set(GITWEB_SUFFIX ) #empty for git ?p=VTK)
94 set(GITWEB_CHECKOUT http://paraview.org/gitweb?p=ParaView.git;a=blob;f=)
95 set(GITWEB_DATA http://paraview.org/gitweb)
96 set(GITWEB_DATA_SUFFIX ) # empty for git ?p=VTKData)
97 set(GITWEB_DATA_CHECKOUT http://paraview.org/gitweb?p=ParaViewData.git;a=blob;f=)
98 
99 # DOXYFILE:
100 # Path to the Doxygen configuration file (i.e. doxyfile).
101 # Example:
102 # DOXYFILE $DOXTEMP/doxyfile
103 #
104 set(DOXYFILE "${DOXTEMP}/doxyfile")
105 
106 # OUTPUT_DIRECTORY ALLOW_ERASE_OUTPUT_DIRECTORY:
107 # Path to the Doxygen output directory (where the resulting doc is stored).
108 # Note: should be the same as your doxyfile's OUTPUT_DIRECTORY
109 # If ON, allows the output directory to be erased when some advanced output
110 # file have been produced (HTML Help, or TAR archive for example).
111 # Example:
112 # OUTPUT_DIRECTORY $DOXTEMP/doc
113 # ALLOW_ERASE_OUTPUT_DIRECTORY ON
114 #
115 set(OUTPUT_DIRECTORY "${DOXTEMP}/doc")
116 set(ALLOW_ERASE_OUTPUT_DIRECTORY ON)
117 
118 # COMPILE_HTML_HELP RESULTING_HTML_HELP_FILE:
119 # Compile the CHM (Compressed HTML) HTML Help file, name of the resulting
120 # file. If set to ON and name is non-empty these options will actually
121 # trigger the HTML-Help compiler to create the CHM. The resulting
122 # file (usually index.chm) will be renamed to this name.
123 # Note: if ON, the whole $OUTPUT_DIRECTORY will be erased at the end of
124 # this script, since this file is considered to be one of the
125 # advanced final output, unless ALLOW_ERASE_OUTPUT_DIRECTORY is OFF
126 # Note: your doxyfile should be configured to enable HTML Help creation
127 # (using GENERATE_HTML YES, GENERATE_HTMLHELP YES)
128 # Example:
129 # COMPILE_HTML_HELP ON
130 # COMPILE_HTML_HELP
131 # RESULTING_HTML_HELP_FILE $DOXTEMP/vtk5.9.chm
132 #
133 set(COMPILE_HTML_HELP OFF)
134 set(RESULTING_HTML_HELP_FILE "${DOXTEMP}/vtk5.9.chm")
135 
136 # CREATE_HTML_TARZ_ARCHIVE RESULTING_HTML_TARZ_ARCHIVE_FILE:
137 # Create a compressed (gzip) tar archive of the html directory (located
138 # under the OUTPUT_DIRECTORY), and name of the resulting archive file.
139 # Note: your doxyfile should be configured to enable HTML creation
140 # (using GENERATE_HTML YES)
141 # Example:
142 # CREATE_HTML_TARZ_ARCHIVE ON
143 # CREATE_HTML_TARZ_ARCHIVE ON
144 # RESULTING_HTML_TARZ_ARCHIVE_FILE $DOXTEMP/vtk5.9-html.tar.gz
145 #
146 set(CREATE_HTML_TARZ_ARCHIVE OFF)
147 set(RESULTING_HTML_TARZ_ARCHIVE_FILE "${DOXTEMP}/ParaView-html.tar.gz")
148 
149 # DOWNLOAD_VTK_TAGFILE VTK_TAGFILE VTK_TAGFILE_REMOTE_DIR VTK_TAGFILE_DEST_DIR:
150 # Download the VTK tag file, name, remote location and destination dir of this
151 # tag file. If set to ON, the tag file is retrieved from its remote location
152 # using wget and stored in the destination dir. It will be automatically
153 # deleted at the end of this script.
154 # Note: your doxyfile must be tailored to make use-of or create this tag file.
155 # (using TAGFILES = vtk5-nightly.tag=http://www.vtk.org/doc/nightly/html
156 # or GENERATE_TAGFILE = "/builds/gitlab-kitware-sciviz-ci/build/Utilities/Doxygen/vtk5.9.tag")
157 # Example:
158 # DOWNLOAD_VTK_TAGFILE=OFF
159 # VTK_TAGFILE=vtk5-nightly.tag
160 # VTK_TAGFILE_REMOTE_DIR=http://www.vtk.org/doc/nightly/html
161 # VTK_TAGFILE_DEST_DIR=$DOXTEMP
162 #
163 set(DOWNLOAD_VTK_TAGFILE ON)
164 set(VTK_TAGFILE vtkNightlyDoc.tag.gz)
165 set(VTK_TAGFILE_REMOTE_DIR http://www.vtk.org/files/nightly)
166 set(VTK_TAGFILE_DEST_DIR "${DOXTEMP}")
167 
168 # ----------------------------------------------------------------------------
169 # SOURCE_DIRECTORIES
170 #
171 # This list is processed by several perl scripts below. Keeping it in one
172 # list avoids the possibility that multiple lists might get out of sync with
173 # rushed edits...
174 #
175 set(SOURCE_DIRECTORIES
176  "/builds/gitlab-kitware-sciviz-ci/Adaptors/CTH"
177  "/builds/gitlab-kitware-sciviz-ci/Adaptors/Cam/Python"
178  "/builds/gitlab-kitware-sciviz-ci/Adaptors/Cam"
179  "/builds/gitlab-kitware-sciviz-ci/Adaptors/CatalystTestDriver"
180  "/builds/gitlab-kitware-sciviz-ci/Adaptors/NPIC"
181  "/builds/gitlab-kitware-sciviz-ci/Adaptors/Pagosa"
182  "/builds/gitlab-kitware-sciviz-ci/Adaptors/Particle"
183  "/builds/gitlab-kitware-sciviz-ci/Adaptors/Phasta"
184  "/builds/gitlab-kitware-sciviz-ci/Adaptors/Python"
185  "/builds/gitlab-kitware-sciviz-ci/Clients/Catalyst"
186  "/builds/gitlab-kitware-sciviz-ci/Clients/InSitu"
187  "/builds/gitlab-kitware-sciviz-ci/Clients/PythonCatalyst"
188  "/builds/gitlab-kitware-sciviz-ci/Clients/Web"
189  "/builds/gitlab-kitware-sciviz-ci/Examples/Plugins/ElevationFilter/Plugin/ElevationFilters"
190  "/builds/gitlab-kitware-sciviz-ci/Examples/Plugins/LagrangianIntegrationModel/Plugin/LagrangianExample"
191  "/builds/gitlab-kitware-sciviz-ci/Examples/Plugins/Representation/Plugin/GeometryRepresentations"
192  "/builds/gitlab-kitware-sciviz-ci/Examples/Plugins/SMMyProxy/Plugin/MyProxy"
193  "/builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents"
194  "/builds/gitlab-kitware-sciviz-ci/Qt/Components"
195  "/builds/gitlab-kitware-sciviz-ci/Qt/Core"
196  "/builds/gitlab-kitware-sciviz-ci/Qt/Python"
197  "/builds/gitlab-kitware-sciviz-ci/Qt/Widgets"
198  "/builds/gitlab-kitware-sciviz-ci/Remoting/Animation"
199  "/builds/gitlab-kitware-sciviz-ci/Remoting/Application"
200  "/builds/gitlab-kitware-sciviz-ci/Remoting/ClientServerStream"
201  "/builds/gitlab-kitware-sciviz-ci/Remoting/Core"
202  "/builds/gitlab-kitware-sciviz-ci/Remoting/Export"
203  "/builds/gitlab-kitware-sciviz-ci/Remoting/Live"
204  "/builds/gitlab-kitware-sciviz-ci/Remoting/Misc"
205  "/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager"
206  "/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManagerPython"
207  "/builds/gitlab-kitware-sciviz-ci/Remoting/Settings"
208  "/builds/gitlab-kitware-sciviz-ci/Remoting/Views"
209  "/builds/gitlab-kitware-sciviz-ci/Remoting/ViewsPython"
210  "/builds/gitlab-kitware-sciviz-ci/Web/Python"
211 
212 )
213 
214 # ----------------------------------------------------------------------------
215 # Print some progress. Be nice to the build watcher.
216 
217 macro(step n desc)
218  message(STATUS "")
219  message(STATUS "Building VTK docs: step ${n} of 13, (${desc})")
220  message(STATUS "----------------------------------------------------------------------------")
221 endmacro()
222 
223 macro(echo v)
224  message(STATUS "${v}='${${v}}'")
225 endmacro()
226 
227 # ----------------------------------------------------------------------------
228 # Values of this script's variables:
229 
230 message(STATUS "")
231 message(STATUS "Building VTK Documentation: initial variable values")
232 message(STATUS "----------------------------------------------------------------------------")
233 
234 foreach(var
235  CMAKE_CURRENT_LIST_FILE
236  CMAKE_MAJOR_VERSION
237  CMAKE_MINOR_VERSION
238  CMAKE_PATCH_VERSION
239  DOXYGEN
240  DOXYGEN_DOT_EXECUTABLE
241  HTML_HELP_COMPILER
242  PERL
243  PROJECT_NAME
244  PATH_TO_VTK_DOX_SCRIPTS
245  SOURCE_DIR
246  REL_PATH_TO_TOP
247  DOXTEMP
248  INTERMEDIATE_DOX_DIR
249  DATA_ROOT
250  GITWEB
251  GITWEB_SUFFIX
252  GITWEB_CHECKOUT
253  GITWEB_DATA
254  GITWEB_DATA_SUFFIX
255  GITWEB_DATA_CHECKOUT
256  DOXYFILE
257  OUTPUT_DIRECTORY
258  ALLOW_ERASE_OUTPUT_DIRECTORY
259  COMPILE_HTML_HELP
260  RESULTING_HTML_HELP_FILE
261  CREATE_HTML_TARZ_ARCHIVE
262  RESULTING_HTML_TARZ_ARCHIVE_FILE
263  DOWNLOAD_VTK_TAGFILE
264  VTK_TAGFILE
265  VTK_TAGFILE_REMOTE_DIR
266  VTK_TAGFILE_DEST_DIR
267  SOURCE_DIRECTORIES
268 )
269  echo(${var})
270 endforeach()
271 
272 # ----------------------------------------------------------------------------
273 # Convert the VTK headers to the Doxygen format.
274 
275 step(1 "convert VTK headers to doxygen format")
276 file(MAKE_DIRECTORY "${INTERMEDIATE_DOX_DIR}")
277 #execute_process(COMMAND ${PERL}
278 # "${PATH_TO_VTK_DOX_SCRIPTS}/doc_header2doxygen.pl"
279 # --to "${INTERMEDIATE_DOX_DIR}"
280 # --relativeto "${SOURCE_DIR}/${REL_PATH_TO_TOP}"
281 # ${SOURCE_DIRECTORIES}
282 # RESULT_VARIABLE rv
283 #)
284 #
285 #if (rv)
286 # message(FATAL_ERROR "Step failed: ${rv}")
287 #endif()
288 
289 # ----------------------------------------------------------------------------
290 # Build the Events invocation list.
291 
292 step(2 "cross-reference classes to InvokeEvent callers")
293 execute_process(COMMAND ${PERL}
294  "${PATH_TO_VTK_DOX_SCRIPTS}/doc_codematch.pl"
295  --codematch "\\w(?:->|\\.)InvokeEvent\\s*\\(\\s*(vtkCommand::\\w+)[\\s,]"
296  --label "Events"
297  --project "${PROJECT_NAME}"
298  --sectionmatch "^vtkCommand::(\\w)"
299  --store "doc_${PROJECT_NAME}_events.dox"
300  --title "Event to Classes"
301  --sectionmatch2 "^vtk(\\w)"
302  --store2 "doc_${PROJECT_NAME}_events2.dox"
303  --title2 "Class to Events"
304  --to "${INTERMEDIATE_DOX_DIR}"
305  --unique "v"
306  --relativeto "${SOURCE_DIR}/${REL_PATH_TO_TOP}"
307  ${SOURCE_DIRECTORIES}
308  RESULT_VARIABLE rv
309 )
310 
311 if (rv)
312  message(FATAL_ERROR "Step failed: ${rv}")
313 endif()
314 
315 # ----------------------------------------------------------------------------
316 # Build the full-text index.
317 
318 step(3 "build full text index -- skipping")
319 # execute_process(COMMAND ${PERL}
320 # "${PATH_TO_VTK_DOX_SCRIPTS}/doc_index.pl"
321 # --project "${PROJECT_NAME}"
322 # --stop "${PATH_TO_VTK_DOX_SCRIPTS}/doc_index.stop"
323 # --store "doc_${PROJECT_NAME}_index.dox"
324 # --to "${INTERMEDIATE_DOX_DIR}"
325 # ${SOURCE_DIRECTORIES}
326 # RESULT_VARIABLE rv
327 # )
328 #
329 # if (rv)
330 # message(FATAL_ERROR "Step failed: ${rv}")
331 # endif()
332 
333 # ----------------------------------------------------------------------------
334 # Extract the VTK version and create the main page.
335 # -- Here we differ from VTK, we simply install the generated
336 # doc_ParaView_version.dox file instead.
337 step(4 "extract ParaView version")
338 #file(INSTALL "${DOXTEMP}/doc_ParaView_version.dox"
339 # DESTINATION "${INTERMEDIATE_DOX_DIR}"
340 # USE_SOURCE_PERMISSIONS)
341 
342 # ----------------------------------------------------------------------------
343 # Generate the 'Class to Examples' page cross-linking each class to these
344 # examples that use that class.
345 
346 step(5 "cross-reference classes with Examples -- skipping")
347 #execute_process(COMMAND ${PERL}
348 # "${PATH_TO_VTK_DOX_SCRIPTS}/doc_class2example.pl"
349 # --baselinedir "${DATA_ROOT}/Baseline"
350 # --baselineicon "pic.gif"
351 # --baselinelink "${GITWEB_DATA_CHECKOUT}Baseline"
352 # --baselinelinksuffix "${GITWEB_DATA_SUFFIX}"
353 # --datamatch "\\W(VTK_DATA_ROOT|VTKData|(vtk)?GetDataRoot|ExpandDataFileName)\\W"
354 # --dataicon "paper-clip.gif"
355 # --dirmatch "^Examples$"
356 # --label "Examples"
357 # --link "${GITWEB_CHECKOUT}"
358 # --linksuffix "${GITWEB_SUFFIX}"
359 # --project "${PROJECT_NAME}"
360 # --store "doc_${PROJECT_NAME}_class2examples.dox"
361 # --title "Class To Examples"
362 # --to "${INTERMEDIATE_DOX_DIR}"
363 # --unique "e"
364 # --remove_leading_slash=1
365 # "${SOURCE_DIR}/${REL_PATH_TO_TOP}"
366 # RESULT_VARIABLE rv
367 #)
368 
369 # ----------------------------------------------------------------------------
370 # Generate the 'Class to Tests' page cross-linking each class to these
371 # tests that use that class.
372 
373 step(6 "cross-reference classes with Testing -- skipping")
374 #execute_process(COMMAND ${PERL}
375 # "${PATH_TO_VTK_DOX_SCRIPTS}/doc_class2example.pl"
376 # --baselinedir "${DATA_ROOT}/Baseline"
377 # --baselineicon "pic.gif"
378 # --baselinelink "${GITWEB_DATA_CHECKOUT}Baseline"
379 # --baselinelinksuffix "${GITWEB_DATA_SUFFIX}"
380 # --datamatch "\\W(VTK_DATA_ROOT|VTKData|(vtk)?GetDataRoot|ExpandDataFileName)\\W"
381 # --dataicon "paper-clip.gif"
382 # --dirmatch "^Testing$"
383 # --label "Tests"
384 # --link "${GITWEB_CHECKOUT}"
385 # --linksuffix "${GITWEB_SUFFIX}"
386 # --project "${PROJECT_NAME}"
387 # --store "doc_${PROJECT_NAME}_class2tests.dox"
388 # --title "Class To Tests"
389 # --to "${INTERMEDIATE_DOX_DIR}"
390 # --unique "t"
391 # --remove_leading_slash=1
392 # "${SOURCE_DIR}/${REL_PATH_TO_TOP}"
393 # RESULT_VARIABLE rv
394 #)
395 
396 # ----------------------------------------------------------------------------
397 # Retrieve the remote VTK tag file.
398 
399 step(7 "download VTK tag file")
400 if(DOWNLOAD_VTK_TAGFILE AND EXISTS "/usr/bin/gunzip")
401  if(NOT VTK_TAGFILE STREQUAL "")
402  file(DOWNLOAD
403  "${VTK_TAGFILE_REMOTE_DIR}/${VTK_TAGFILE}"
404  "${VTK_TAGFILE_DEST_DIR}/${VTK_TAGFILE}"
405  TIMEOUT 60
406  )
407  if(NOT EXISTS "${VTK_TAGFILE_DEST_DIR}/${VTK_TAGFILE}")
408  message(STATUS "warning: VTK tag file did not download correctly")
409  else()
410  message(STATUS "Download ${VTK_TAGFILE_DEST_DIR}/${VTK_TAGFILE}")
411  execute_process(COMMAND
412  "/usr/bin/gunzip" "${VTK_TAGFILE_DEST_DIR}/${VTK_TAGFILE}")
413  endif()
414  endif()
415 endif()
416 
417 # ----------------------------------------------------------------------------
418 # Create the Doxygen doc.
419 
420 step(8 "run doxygen")
421 file(REMOVE_RECURSE "${OUTPUT_DIRECTORY}")
422 file(MAKE_DIRECTORY "${OUTPUT_DIRECTORY}")
423 execute_process(COMMAND ${DOXYGEN} ${DOXYFILE}
424  RESULT_VARIABLE rv
425 )
426 if (rv)
427  message(FATAL_ERROR "Doxygen command failed: ${rv}")
428 endif()
429 
430 # ----------------------------------------------------------------------------
431 # Clean the HTML pages to remove the path to the intermediate Doxygen dir.
432 
433 step(9 "remove intermediate path from html")
434 execute_process(COMMAND ${PERL}
435  "${PATH_TO_VTK_DOX_SCRIPTS}/doc_rmpath.pl"
436  --to "${INTERMEDIATE_DOX_DIR}"
437  --html "${OUTPUT_DIRECTORY}/html"
438  RESULT_VARIABLE rv
439 )
440 
441 if (rv)
442  message(FATAL_ERROR "Step failed: ${rv}")
443 endif()
444 
445 # ----------------------------------------------------------------------------
446 # clean the HTML pages to remove layout problems
447 
448 step(10 "clean html to remove layout problems - skipping")
449 #execute_process(COMMAND ${PERL}
450 # "${PATH_TO_VTK_DOX_SCRIPTS}/doc_cleanhtml.pl"
451 # --html "${OUTPUT_DIRECTORY}/html"
452 # RESULT_VARIABLE rv
453 #)
454 #
455 #if (rv)
456 # message(FATAL_ERROR "Step failed: ${rv}")
457 #endif()
458 
459 # ----------------------------------------------------------------------------
460 # Create the *.chm file
461 
462 step(11 "build *.chm file")
463 if(COMPILE_HTML_HELP AND HTML_HELP_COMPILER)
464  if(NOT "${RESULTING_HTML_HELP_FILE}" STREQUAL "")
465  if(EXISTS "${OUTPUT_DIRECTORY}/html/index.hhp")
466  # hhc creates index.chm next to index.hhp
467  execute_process(COMMAND ${HTML_HELP_COMPILER} index.hhp
468  WORKING_DIRECTORY "${OUTPUT_DIRECTORY}/html"
469  RESULT_VARIABLE rv
470  )
471 
472  if (rv)
473  message(FATAL_ERROR "Command failed: ${rv}")
474  endif()
475  else()
476  message(STATUS "warning: no index.hhp file, not running HTML Help Compiler...")
477  endif()
478 
479  if(EXISTS "${OUTPUT_DIRECTORY}/html/index.chm")
480  # copy it to where we want it
481  execute_process(COMMAND ${CMAKE_COMMAND} -E copy
482  "${OUTPUT_DIRECTORY}/html/index.chm"
483  "${RESULTING_HTML_HELP_FILE}"
484  RESULT_VARIABLE rv
485  )
486 
487  # get rid of the one in the html dir
488  file(REMOVE "${OUTPUT_DIRECTORY}/html/index.chm")
489  else()
490  message(STATUS "warning: no index.chm file, not moving to final location...")
491  endif()
492  endif()
493 endif()
494 
495 # ----------------------------------------------------------------------------
496 # Create the *.tar.gz file
497 
498 if(CREATE_HTML_TARZ_ARCHIVE)
499  step(12 "build *.tar.gz file")
500  if(NOT RESULTING_HTML_TARZ_ARCHIVE_FILE STREQUAL "")
501  execute_process(COMMAND ${CMAKE_COMMAND} -E tar cfz ${RESULTING_HTML_TARZ_ARCHIVE_FILE} html
502  WORKING_DIRECTORY ${OUTPUT_DIRECTORY}
503  RESULT_VARIABLE rv
504  )
505 
506  if (rv)
507  message(FATAL_ERROR "Command failed: ${rv}")
508  endif()
509  endif()
510 else()
511  step(12 "build *.tar.gz file -- skipping")
512 endif()
513 
514 # ----------------------------------------------------------------------------
515 # Clean-up.
516 
517 if(DOXYGEN_KEEP_TEMP)
518  message("Skipping step 13: clean up.")
519 else()
520  step(13 "clean up")
521  file(REMOVE_RECURSE "${INTERMEDIATE_DOX_DIR}")
522 
523  if(DOWNLOAD_VTK_TAGFILE)
524  if(NOT VTK_TAGFILE STREQUAL "")
525  file(REMOVE "${VTK_TAGFILE_DEST_DIR}/${VTK_TAGFILE}")
526  endif()
527  endif()
528 
529  if(COMPILE_HTML_HELP)
530  if(NOT RESULTING_HTML_HELP_FILE STREQUAL "")
531  if(ALLOW_ERASE_OUTPUT_DIRECTORY)
532  file(REMOVE_RECURSE "${OUTPUT_DIRECTORY}")
533  endif()
534  endif()
535  endif()
536 endif()
537 
538 #
539 # If you add more steps, please update the step macro to reflect the total
540 # number of steps in the progressive build output... Thanks.
541 #
Generated by   doxygen 1.8.13 on Wed Jan 27 2021