From 39ddae4cb8b1a4b35c8c9b8c30532e5fa96b2e0d Mon Sep 17 00:00:00 2001 From: navarro Date: Thu, 25 Oct 2012 15:58:14 +0200 Subject: [PATCH] Attach the dev guide to forge and doc --- buildtools/Cmake/GenerateDevGuide.cmake | 19 +++++++++++++++++++ buildtools/Cmake/GenerateDoc.cmake | 9 +++++++++ doc/Doxyfile.in | 4 +++- doc/SimgridDoxygenLayout.xml | 1 + doc/dev_guide/doxygen/DevGuideDoxyfile.in | 2 +- doc/dev_guide/doxygen/header.html | 2 +- doc/dev_guide/doxygen/index.doc | 3 ++- doc/index.doc | 1 + doc/ref_guide/doxygen/header.html | 3 ++- doc/user_guide/doxygen/header.html | 3 ++- 10 files changed, 41 insertions(+), 6 deletions(-) diff --git a/buildtools/Cmake/GenerateDevGuide.cmake b/buildtools/Cmake/GenerateDevGuide.cmake index 4e1ce97acc..e20f2890ad 100644 --- a/buildtools/Cmake/GenerateDevGuide.cmake +++ b/buildtools/Cmake/GenerateDevGuide.cmake @@ -2,6 +2,11 @@ if(DOXYGEN_PATH) + set(DOC_PNGS + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png + ) + configure_file(${CMAKE_HOME_DIRECTORY}/doc/dev_guide/doxygen/DevGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/doxygen/DevGuideDoxyfile @ONLY) ADD_CUSTOM_TARGET(dev_guide @@ -13,6 +18,20 @@ if(DOXYGEN_PATH) WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/ ) + foreach(file ${DOC_FIGS}) + string(REPLACE ".fig" ".png" tmp_file ${file}) + string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html/" tmp_file ${tmp_file}) + ADD_CUSTOM_COMMAND(TARGET dev_guide + COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file} + ) + endforeach(file ${DOC_FIGS}) + + foreach(file ${DOC_PNGS}) + ADD_CUSTOM_COMMAND(TARGET dev_guide + COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html/ + ) + endforeach(file ${DOC_PNGS}) + ADD_CUSTOM_COMMAND(TARGET dev_guide COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" COMMAND ${DOXYGEN_PATH}/doxygen DevGuideDoxyfile diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index 18c0ae92a2..c69b51629e 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -88,14 +88,23 @@ add_custom_target(sync-gforge-doc COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/ || true COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/ || true + COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/ || true COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html/ || true + COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/html/ || true + COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true + COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times doc/user_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true + COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times doc/ref_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html || true + + COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times + doc/dev_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/html || true + COMMAND scp doc/user_guide/html/simgrid_modules2.png doc/user_guide/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}" diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 83195ba34b..6c231fd5dd 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1557,7 +1557,9 @@ SKIP_FUNCTION_MACROS = YES # NOT include the path). If a tag file is not located in the directory in which # doxygen is run, you must also specify the path to the tagfile here. -TAGFILES = shared/doxygen/simgridrefguide.tag=ref_guide/html/ shared/doxygen/simgriduserguide.tag=user_guide/html/ +TAGFILES = shared/doxygen/simgridrefguide.tag=ref_guide/html/ \ + shared/doxygen/simgriduserguide.tag=user_guide/html/ \ + shared/doxygen/simgriddevguide.tag=dev_guide/html/ # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. diff --git a/doc/SimgridDoxygenLayout.xml b/doc/SimgridDoxygenLayout.xml index 263b04f173..c6712398fb 100644 --- a/doc/SimgridDoxygenLayout.xml +++ b/doc/SimgridDoxygenLayout.xml @@ -4,6 +4,7 @@ + diff --git a/doc/dev_guide/doxygen/DevGuideDoxyfile.in b/doc/dev_guide/doxygen/DevGuideDoxyfile.in index e1c17c69d7..698cce167c 100644 --- a/doc/dev_guide/doxygen/DevGuideDoxyfile.in +++ b/doc/dev_guide/doxygen/DevGuideDoxyfile.in @@ -29,7 +29,7 @@ DOXYFILE_ENCODING = UTF-8 # identify the project. Note that if you do not use Doxywizard you need # to put quotes around the project name if it contains spaces. -PROJECT_NAME = "SimGrid Developer Guide" +PROJECT_NAME = SimGrid # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or diff --git a/doc/dev_guide/doxygen/header.html b/doc/dev_guide/doxygen/header.html index 4aaa6d1570..65b3ebe45f 100644 --- a/doc/dev_guide/doxygen/header.html +++ b/doc/dev_guide/doxygen/header.html @@ -49,7 +49,7 @@ $mathjax