Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Attach the dev guide to forge and doc
authornavarro <navarro@caraja.(none)>
Thu, 25 Oct 2012 13:58:14 +0000 (15:58 +0200)
committernavarro <navarro@caraja.(none)>
Thu, 25 Oct 2012 13:58:14 +0000 (15:58 +0200)
buildtools/Cmake/GenerateDevGuide.cmake
buildtools/Cmake/GenerateDoc.cmake
doc/Doxyfile.in
doc/SimgridDoxygenLayout.xml
doc/dev_guide/doxygen/DevGuideDoxyfile.in
doc/dev_guide/doxygen/header.html
doc/dev_guide/doxygen/index.doc
doc/index.doc
doc/ref_guide/doxygen/header.html
doc/user_guide/doxygen/header.html

index 4e1ce97..e20f289 100644 (file)
@@ -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
index 18c0ae9..c69b516 100644 (file)
@@ -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}"
index 83195ba..6c231fd 100644 (file)
@@ -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.
index 263b04f..c671239 100644 (file)
@@ -4,6 +4,7 @@
     <tab type="mainpage" visible="yes" title="Home"/>
     <tab type="user" url="../ref_guide/html/index.html" title="Reference Manual"/>
     <tab type="user" url="../user_guide/html/index.html" title="User Guide"/>
+    <tab type="user" url="../dev_guide/html/index.html" title="Developer Guide"/>
     <tab type="user" url="http://simgrid.gforge.inria.fr/tutorials" title="Tutorials"/>
     <tab type="user" url="https://gforge.inria.fr/projects/simgrid" title="Forge"/>
     <tab type="user" url="http://simgrid.gforge.inria.fr/" title="Website"/>
index e1c17c6..698cce1 100644 (file)
@@ -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
index 4aaa6d1..65b3ebe 100644 (file)
@@ -49,7 +49,7 @@ $mathjax
 
 <div id="navrow1" class="tabs">
     <ul class="tablist">
-      <li><a href="../../doc/index.html"><span>Home</span></a></li>
+      <li><a href="../../html/index.html"><span>Home</span></a></li>
       <li><a href="../../ref_guide/html/index.html"><span>Reference&nbsp;Manual</span></a></li>
       <li><a href="../../user_guide/html/index.html"><span>User&nbsp;Guide</span></a></li>
       <li class="current"><a href="index.html"><span>Developer&nbsp;Guide</span></a></li>
index fe5f938..0152155 100644 (file)
@@ -1,5 +1,6 @@
 /*!
-@mainpage SimGrid Developer Guide - Welcome
+@mainpage SimGrid Developer Guide
+
 <center>
 \htmlonly
 <table width="100%">
index 8b1414a..c1fe91d 100644 (file)
@@ -17,6 +17,7 @@ Currently, the documentation contains 3 main sections:
 <ul>
   <li><h2><a href="../user_guide/html/index.html">SimGrid User Guide</a></h2></li>
   <li><h2><a href="../ref_guide/html/index.html">SimGrid Reference Manual</a>.</h2></li>
+  <li><h2><a href="../dev_guide/html/index.html">SimGrid Developer Manual</a>.</h2></li>
   <li><h2>You can also retrieve tutorials from <a href="http://simgrid.gforge.inria.fr/faq.html">here</a>.</h2></li> 
 </ul>
 \endhtmlonly
index 8773d3f..a1cd7d1 100644 (file)
@@ -49,9 +49,10 @@ $mathjax
 
 <div id="navrow1" class="tabs">
     <ul class="tablist">
-      <li><a href="../../doc/index.html"><span>Home</span></a></li>
+      <li><a href="../../html/index.html"><span>Home</span></a></li>
       <li class="current"><a href="index.html"><span>Reference&nbsp;Manual</span></a></li>
       <li><a href="../../user_guide/html/index.html"><span>User&nbsp;Guide</span></a></li>
+      <li><a href="../../dev_guide/html/index.html"><span>Developer&nbsp;Guide</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/tutorials"><span>Tutorials</span></a></li>
       <li><a href="https://gforge.inria.fr/projects/simgrid"><span>Forge</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/"><span>Website</span></a></li>
index de0a5e7..75bc94f 100644 (file)
@@ -49,9 +49,10 @@ $mathjax
 
 <div id="navrow1" class="tabs">
     <ul class="tablist">
-      <li><a href="../../doc/index.html"><span>Home</span></a></li>
+      <li><a href="../../html/index.html"><span>Home</span></a></li>
       <li><a href="../../ref_guide/html/index.html"><span>Reference&nbsp;Manual</span></a></li>
       <li class="current"><a href="../../user_guide/html/index.html"><span>User&nbsp;Guide</span></a></li>
+      <li><a href="../../dev_guide/html/index.html"><span>Developer&nbsp;Guide</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/tutorials"><span>Tutorials</span></a></li>
       <li><a href="https://gforge.inria.fr/projects/simgrid"><span>Forge</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/"><span>Website</span></a></li>