Changeset 412

Timestamp:

11/10/09 17:47:27 (14 years ago)

Author:

pinsard

Message:

draft for docompileall.sh, not yet in production

Location:

trunk/SRC/Documentation/xmldoc

Files:

• docompileall.sh (added)
• doidldoc.sh (modified) (3 diffs)

trunk/SRC/Documentation/xmldoc/doidldoc.sh

@@ -39 +39 @@
 # Be warned that assitant help is only available with ``idldoc 2.0``.
 #
+# CAUTIONS
+# ========
+#
+# SAXO_DIR must be set. The value should be the directory where
+# SAXO is available.
+#
+# for example, if you work at LOCEAN and work with default SAXO,
+# SAXO_DIR=/usr/home/smasson/SAXO_DIR/.
+#
+# For working in progress, you should checkout SAXO on a personnal
+# directory and set SAXO_DIR to the working space.
+#
+# example for me : SAXO_DIR=${HOME}/SAXO_DIR_ws/
+#
 # EXAMPLES
 # ========
@@ -47 +61 @@
 # ::
 #
-# $ cd SAXO_ws/SRC/Documentations/xmldoc/
-# $ doidldoc.sh -i ../.. -t "SAXO Documentation" -o ./idldoc_html_output/
-#
-# To produce AMSU HTML outputs :
+# $ cd SAXO_ws/SRC/Documentation/xmldoc/
+# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/doidldoc.sh -i ../.. -t "SAXO Documentation" -o ./idldoc_html_output/
+#
+# To produce VARAMMA HTML outputs :
 # ::
 #
-# $ cd /usr/home/fplod/incas/amsu/amsu_ws/
-# $ doidldoc.sh -i . -t "AMSU Documentation" -o /tmp/idldoc_html_output/
+# $ cd /usr/home/fplod/incas/varamma/varamma_ws/
+# $ ${SAXO_DIR}/SRC/Documentation/xmldoc/doidldoc.sh -i . -t "VARAMMA Documentation" -o /tmp/idldoc_html_output/
 #
 # TODO
@@ -91 +105 @@
 #
 # $Id$
+#
+# - fplod 20091110T151839Z aedon.locean-ipsl.upmc.fr (Darwin)
+#   
+#   * add CAUTIONS about SAXO_DIR environment variable
+#     and usage in EXAMPLES
 #
 # - ++