##
## ---------------------------------------------------------------------
+#
+# 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
#
# Prepare the example steps for doxygen:
#
ADD_SUBDIRECTORY(tutorial) # uses ${DEAL_II_STEPS}
-ADD_SUBDIRECTORY(images)
#
# Prepare auxiliary files for doxygen:
${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
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
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
)
+++ /dev/null
-## ---------------------------------------------------------------------
-## $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
- )
+++ /dev/null
-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"];
-}