Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
tesh now reports if the outputs were sorted on mismatch
[simgrid.git] / doc / doxygen / inside_doxygen.doc
index b959461..f599035 100644 (file)
@@ -181,7 +181,7 @@ complete your day.
 
 If you need to run a command (like fig2dev) to generate your image,
 edit buildtools/Cmake/GenerateDoc.cmake and add your command to the
-simgrid_documentation target (grep for fig2dev in the file to see
+doc target (grep for fig2dev in the file to see
 where exactly). Don't forget to add the source of your image to the
 archive somehow. You can add it to the list DOC_FIG of
 buildtools/Cmake/DefinePackage.cmake.
@@ -204,5 +204,24 @@ website now (there is a README in the repo with more details).
 git clone git://scm.gforge.inria.fr/simgrid/website.git
 @endverbatim
 
+\section inside_doxygen_regen Regenerating the documentation
+
+Once you've changed the doc, you want to run doxygen to regenerate the
+html output (and maybe the pdf too). Here is how to do this:
+
+@verbatim
+make doc # html documentation
+make pdf # the result is in doc/latex/simgrid_documentation.pdf
+@endverbatim
+
+Once you're satisfyied with the result, refreshing the documentation
+on the web pages is very easy, as shown below. A few permission errors
+are ok, unfortunately. We should improve things here, but I'm not sure
+of how. A funny thing is that this make target is also provided in the
+archives we distribute to the users, but I guess that it's harmless :)
+
+@verbatim
+make sync-gforge-doc
+@endverbatim
 
 */