From: maier Date: Fri, 6 Dec 2013 01:13:08 +0000 (+0000) Subject: Documentation: Cleanup, and remove obsolete dot invocation X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1ea8cdbff3a190439e24c85066e482b5983014ca;p=dealii-svn.git Documentation: Cleanup, and remove obsolete dot invocation git-svn-id: https://svn.dealii.org/trunk@31903 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/doc/CMakeLists.txt b/deal.II/doc/CMakeLists.txt index c4ec069aff..b7efaf534c 100644 --- a/deal.II/doc/CMakeLists.txt +++ b/deal.II/doc/CMakeLists.txt @@ -21,31 +21,7 @@ IF(DEAL_II_COMPONENT_DOCUMENTATION) MESSAGE(STATUS "Setup documentation") - # - # Required packages for the document generation: - # - FIND_PACKAGE(Perl) - FIND_PACKAGE(Doxygen) - - # - # Do we have all necessary dependencies? - # - IF(NOT PERL_FOUND) - MESSAGE(FATAL_ERROR - "Could not find a perl installation which is required for building the documentation" - ) - ENDIF() - IF(NOT DOXYGEN_FOUND OR NOT DOXYGEN_DOT_FOUND) - MESSAGE(FATAL_ERROR - "Could not find doxygen and dot which is required for building the documentation" - ) - ENDIF() - - # - # Generate the source documentation via doxygen: - # ADD_SUBDIRECTORY(doxygen) - ADD_DEPENDENCIES(documentation doxygen) # # Install the static elements of the html documentation: diff --git a/deal.II/doc/doxygen/CMakeLists.txt b/deal.II/doc/doxygen/CMakeLists.txt index 17fd2d2b1f..065b0d20ff 100644 --- a/deal.II/doc/doxygen/CMakeLists.txt +++ b/deal.II/doc/doxygen/CMakeLists.txt @@ -14,6 +14,27 @@ ## ## --------------------------------------------------------------------- +# +# Generate the source documentation via doxygen: +# + +FIND_PACKAGE(Perl) +FIND_PACKAGE(Doxygen) + +# +# Do we have all necessary dependencies? +# +IF(NOT PERL_FOUND) + MESSAGE(FATAL_ERROR + "Could not find a perl installation which is required for building the documentation" + ) +ENDIF() +IF(NOT DOXYGEN_FOUND) + MESSAGE(FATAL_ERROR + "Could not find doxygen which is required for building the documentation" + ) +ENDIF() + # # A glob. I'm sorry # @@ -25,7 +46,6 @@ file(GLOB DEAL_II_STEPS # Prepare the example steps for doxygen: # ADD_SUBDIRECTORY(tutorial) # uses ${DEAL_II_STEPS} -ADD_SUBDIRECTORY(images) # # Prepare auxiliary files for doxygen: @@ -35,12 +55,6 @@ CONFIGURE_FILE( ${CMAKE_CURRENT_BINARY_DIR}/options.dox ) -CONFIGURE_FILE( - ${CMAKE_CURRENT_SOURCE_DIR}/deal.css - ${CMAKE_CURRENT_BINARY_DIR}/deal.II/deal.css - COPYONLY - ) - CONFIGURE_FILE( ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css ${CMAKE_CURRENT_BINARY_DIR}/stylesheet.css @@ -129,7 +143,6 @@ ADD_CUSTOM_COMMAND( WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} DEPENDS tutorial - images ${CMAKE_CURRENT_BINARY_DIR}/options.dox ${CMAKE_CURRENT_BINARY_DIR}/header.html ${CMAKE_CURRENT_BINARY_DIR}/footer.html @@ -140,10 +153,10 @@ ADD_CUSTOM_COMMAND( ADD_CUSTOM_TARGET(doxygen ALL DEPENDS ${CMAKE_BINARY_DIR}/doxygen.log ) +ADD_DEPENDENCIES(documentation doxygen) INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/deal.tag - ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css DESTINATION ${DEAL_II_DOCHTML_RELDIR}/doxygen COMPONENT documentation ) diff --git a/deal.II/doc/doxygen/deal.css b/deal.II/doc/doxygen/deal.css deleted file mode 100644 index 716718c669..0000000000 --- a/deal.II/doc/doxygen/deal.css +++ /dev/null @@ -1,18 +0,0 @@ -// -// Copyright (C) 1998 - 2013 by the deal.II authors -// - -table.tutorial { - color: black; - border: 1px solid #aaa; - background-color: #f9f9f9; - padding: 5px; - font-size: 95%; -} -h3 { - font-size: 120%; - text-decoration:underline; -} -h4 { - font-size: 100%; -} diff --git a/deal.II/doc/doxygen/images/CMakeLists.txt b/deal.II/doc/doxygen/images/CMakeLists.txt deleted file mode 100644 index 54a6589526..0000000000 --- a/deal.II/doc/doxygen/images/CMakeLists.txt +++ /dev/null @@ -1,32 +0,0 @@ -## --------------------------------------------------------------------- -## $Id$ -## -## Copyright (C) 2013 by the deal.II authors -## -## This file is part of the deal.II library. -## -## The deal.II library is free software; you can use it, redistribute -## it, and/or modify it under the terms of the GNU Lesser General -## Public License as published by the Free Software Foundation; either -## version 2.1 of the License, or (at your option) any later version. -## The full text of the license can be found in the file LICENSE at -## the top level of the deal.II distribution. -## -## --------------------------------------------------------------------- -ADD_CUSTOM_COMMAND( - OUTPUT - ${CMAKE_CURRENT_BINARY_DIR}/structure.png - ${CMAKE_CURRENT_BINARY_DIR}/structure.cmapx - COMMAND ${DOXYGEN_DOT_EXECUTABLE} - -Tpng -o ${CMAKE_CURRENT_BINARY_DIR}/structure.png - -Tcmapx -o ${CMAKE_CURRENT_BINARY_DIR}/structure.cmapx - ${CMAKE_CURRENT_SOURCE_DIR}/structure.dot - DEPENDS - ${CMAKE_CURRENT_SOURCE_DIR}/structure.dot - ) - -ADD_CUSTOM_TARGET(images - DEPENDS - ${CMAKE_CURRENT_BINARY_DIR}/structure.png - ${CMAKE_CURRENT_BINARY_DIR}/structure.cmapx - ) diff --git a/deal.II/doc/doxygen/images/structure.dot b/deal.II/doc/doxygen/images/structure.dot deleted file mode 100644 index 936be67955..0000000000 --- a/deal.II/doc/doxygen/images/structure.dot +++ /dev/null @@ -1,37 +0,0 @@ -digraph G -{ - graph[rankdir="TB",aspect=1.5,bgcolor="transparent"]; - - edge [fontname="FreeSans",fontsize=10,labelfontname="FreeSans",labelfontsize=10]; - node [fontname="FreeSans",fontsize=10, - shape=record,height=0.2,width=0.4, - color="black", fillcolor="white", style="filled"]; - - FE [label="FiniteElement",URL="../deal.II/group_fe.html"]; - Tria [label="Triangulation",URL="../deal.II/group_grid.html"]; - DoFHandler [label="DoFHandler",URL="../deal.II/group_dofs.html"]; - Quadrature [label="Quadrature",URL="../deal.II/group_Quadrature.html"]; - Mapping [label="Mapping",URL="../deal.II/group_mapping.html"]; - FEValues [label="FEValues",URL="../deal.II/group_feaccess.html"]; -# MeshWorker [label="MeshWorker",URL="../deal.II/group_MeshWorker.html"]; -# Forms [label="(Bi-)Linear Forms",URL="../deal.II/group_Integrators.html"]; - Linear [label="Discrete System",URL="../deal.II/group_LAC.html"]; - LinearSolver [label="Solver",URL="../deal.II/group_Solvers.html"]; - Output [label="Output",URL="../deal.II/group_output.html"]; - - Tria -> DoFHandler [color="black",fontsize=10,style="solid",fontname="FreeSans"]; -# Tria -> FEValues [color="black",fontsize=10,style="solid",fontname="FreeSans"]; - FE -> DoFHandler [color="black",fontsize=10,style="solid",fontname="FreeSans"]; - FE -> FEValues [color="black",fontsize=10,style="solid",fontname="FreeSans"]; - Mapping -> FEValues [color="black",fontsize=10,style="solid",fontname="FreeSans"]; - Quadrature -> FEValues [color="black",fontsize=10,style="solid",fontname="FreeSans"]; - FEValues -> Linear [color="black",fontsize=10,style="solid",fontname="FreeSans"]; -# FEValues -> MeshWorker [color="black",fontsize=10,style="solid",fontname="FreeSans"]; -# FEValues -> Forms [color="black",fontsize=10,style="solid",fontname="FreeSans"]; -# Forms -> MeshWorker [color="black",fontsize=10,style="solid",fontname="FreeSans"]; - DoFHandler -> Linear [color="black",fontsize=10,style="solid",fontname="FreeSans"]; -# DoFHandler -> MeshWorker [color="black",fontsize=10,style="solid",fontname="FreeSans"]; -# MeshWorker -> Linear [color="black",fontsize=10,style="solid",fontname="FreeSans"]; - Linear -> LinearSolver [color="black",fontsize=10,style="solid",fontname="FreeSans"]; - LinearSolver -> Output [color="black",fontsize=10,style="solid",fontname="FreeSans"]; -}