From: maier Date: Mon, 8 Oct 2012 23:31:11 +0000 (+0000) Subject: A bunch of bugfixes and code cleanup for the documentation X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8e51e5069168a99ec4d24993faf5bb1c195ee471;p=dealii-svn.git A bunch of bugfixes and code cleanup for the documentation git-svn-id: https://svn.dealii.org/branches/branch_cmake@27020 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/doc/doxygen/CMakeLists.txt b/deal.II/doc/doxygen/CMakeLists.txt index 45bbbeb0f3..d861e6a08c 100644 --- a/deal.II/doc/doxygen/CMakeLists.txt +++ b/deal.II/doc/doxygen/CMakeLists.txt @@ -24,7 +24,7 @@ ENDIF() # -# Prepare the example steps for inclusion: +# Prepare the example steps for doxygen: # ADD_SUBDIRECTORY(tutorial) @@ -77,17 +77,18 @@ ADD_CUSTOM_COMMAND( file(GLOB doxygen_input ${CMAKE_SOURCE_DIR}/include/deal.II/* ${CMAKE_BINARY_DIR}/include/deal.II/* + ${CMAKE_CURRENT_SOURCE_DIR}/headers + ${CMAKE_CURRENT_BINARY_DIR}/tutorial ${CMAKE_SOURCE_DIR}/doc/news/*.h ${CMAKE_SOURCE_DIR}/contrib/parameter_gui/*.h ${CMAKE_SOURCE_DIR}/contrib/parameter_gui/main.cpp - ${CMAKE_CURRENT_SOURCE_DIR}/headers - ${CMAKE_CURRENT_BINARY_DIR}/tutorial ) TO_STRING(doxygen_input ${doxygen_input}) file(GLOB doxygen_image_path ${CMAKE_CURRENT_SOURCE_DIR}/images + ${CMAKE_CURRENT_BINARY_DIR}/images ${CMAKE_SOURCE_DIR}/examples/*/doc ${CMAKE_SOURCE_DIR}/contrib/parameter_gui/images ) @@ -100,7 +101,12 @@ FILE(APPEND "${CMAKE_CURRENT_BINARY_DIR}/options.dox" " ) -ADD_CUSTOM_TARGET(doxygen ALL # TODO: Really all? + +# +# And, finally, call doxygen: +# + +ADD_CUSTOM_TARGET(doxygen ALL # # ./deal.II is already created due to CONFIGURE_FILE(... deal.css ...) # @@ -116,6 +122,7 @@ ADD_CUSTOM_TARGET(doxygen ALL # TODO: Really all? ADD_DEPENDENCIES(doxygen tutorial) INSTALL(DIRECTORY + ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css ${CMAKE_CURRENT_BINARY_DIR}/deal.II DESTINATION ${DEAL_II_DOCUMENTATION_RELDIR}/doxygen COMPONENT documentation diff --git a/deal.II/doc/doxygen/images/Makefile b/deal.II/doc/doxygen/images/Makefile deleted file mode 100644 index e649676cb6..0000000000 --- a/deal.II/doc/doxygen/images/Makefile +++ /dev/null @@ -1,7 +0,0 @@ -# $Id$ - -structure.png: structure.dot - @echo ================== Making $@ - @dot -Tpng -Tcmapx -O $< - @mv $<.png $(basename $<).png - @mv $<.cmapx $(basename $<).cmapx diff --git a/deal.II/doc/doxygen/images/structure.cmapx b/deal.II/doc/doxygen/images/structure.cmapx deleted file mode 100644 index 4ed9746888..0000000000 --- a/deal.II/doc/doxygen/images/structure.cmapx +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - - diff --git a/deal.II/doc/doxygen/images/structure.png b/deal.II/doc/doxygen/images/structure.png deleted file mode 100644 index 0e6832bbc0..0000000000 Binary files a/deal.II/doc/doxygen/images/structure.png and /dev/null differ diff --git a/deal.II/doc/doxygen/tutorial/CMakeLists.txt b/deal.II/doc/doxygen/tutorial/CMakeLists.txt index 7a8f2b479c..585a6473d6 100644 --- a/deal.II/doc/doxygen/tutorial/CMakeLists.txt +++ b/deal.II/doc/doxygen/tutorial/CMakeLists.txt @@ -68,6 +68,12 @@ ADD_CUSTOM_COMMAND( ) +# +# TODO: +# Are toc-list.html and toc-topics.html really generated by hand? +# + + # # A target for the preparation of all the stuff happening in here... # @@ -187,8 +193,8 @@ INSTALL(FILES index.html navbar.html title.html - toc-list.html #TODO - toc-topics.html #TODO + toc-list.html + toc-topics.html ${CMAKE_CURRENT_BINARY_DIR}/steps.png ${CMAKE_CURRENT_BINARY_DIR}/toc.html DESTINATION ${DEAL_II_DOCUMENTATION_RELDIR}/doxygen/tutorial diff --git a/deal.II/doc/doxygen/tutorial/steps.png b/deal.II/doc/doxygen/tutorial/steps.png deleted file mode 100644 index 82b260b7f0..0000000000 Binary files a/deal.II/doc/doxygen/tutorial/steps.png and /dev/null differ