r2628 - in /1.2: scons/manuals.py sconstruct -- October 12, 2006 - 09:06

Author: bugman
Date: Thu Oct 12 09:05:36 2006
New Revision: 2628

URL: http://svn.gna.org/viewcvs/relax?rev=2628&view=rev
Log:
Changed the comments and docstrings of the Scons manual targets.

The PDF or HMTL version is now in brackets after the 'user manual' and 'API 
documentation manual'
parts.


Modified:
    1.2/scons/manuals.py
    1.2/sconstruct

Modified: 1.2/scons/manuals.py
URL: 
http://svn.gna.org/viewcvs/relax/1.2/scons/manuals.py?rev=2628&r1=2627&r2=2628&view=diff
==============================================================================
--- 1.2/scons/manuals.py (original)
+++ 1.2/scons/manuals.py Thu Oct 12 09:05:36 2006
@@ -293,13 +293,13 @@
 
 
 def compile_user_manual_html(target, source, env):
-    """Builder action for compiling the HTML version of the user manual from 
the LaTeX sources."""
-
-    # Print out.
-    print
-    print "#################################################"
-    print "# Compiling the HTML version of the user manual #"
-    print "#################################################\n\n"
+    """Builder action for compiling the user manual (HTML version) from the 
LaTeX sources."""
+
+    # Print out.
+    print
+    print "############################################"
+    print "# Compiling the user manual (HTML version) #"
+    print "############################################\n\n"
 
     # Go to the LaTeX directory.
     base_dir = getcwd()
@@ -317,13 +317,13 @@
 
 
 def compile_user_manual_pdf(target, source, env):
-    """Builder action for compiling the PDF version of the user manual from 
the LaTeX sources."""
-
-    # Print out.
-    print
-    print "################################################"
-    print "# Compiling the PDF version of the user manual #"
-    print "################################################\n\n"
+    """Builder action for compiling the user manual (PDF version) from the 
LaTeX sources."""
+
+    # Print out.
+    print
+    print "###########################################"
+    print "# Compiling the user manual (PDF version) #"
+    print "###########################################\n\n"
 
     # Go to the LaTeX directory.
     base_dir = getcwd()

Modified: 1.2/sconstruct
URL: 
http://svn.gna.org/viewcvs/relax/1.2/sconstruct?rev=2628&r1=2627&r2=2628&view=diff
==============================================================================
--- 1.2/sconstruct (original)
+++ 1.2/sconstruct Thu Oct 12 09:05:36 2006
@@ -178,33 +178,33 @@
         # Set up the builder for the standard manual targets (using the 
self.dummy function).
         manual_env.Append(BUILDERS={'Manual' : Builder(action=self.dummy)})
 
-        # Target for creating the PDF version of the user manual.
+        # Target for creating the user manual (PDF version).
         manual_env.Manual(target='user_manual_pdf', source=None)
         manual_env.Depends('user_manual_pdf', 'manual_clean')
         manual_env.Depends('user_manual_pdf', 'manual_version_file')
         manual_env.Depends('user_manual_pdf', 'fetch_docstrings')
         manual_env.Depends('user_manual_pdf', 'compile_user_manual_pdf')
 
-        # Target for creating the PDF version of the user manual (without 
fetching the docstrings).
+        # Target for creating the user manual (PDF version, without fetching 
the docstrings).
         manual_env.Manual(target='user_manual_pdf_nofetch', source=None)
         manual_env.Depends('user_manual_pdf_nofetch', 'manual_clean')
         manual_env.Depends('user_manual_pdf_nofetch', 'manual_version_file')
         manual_env.Depends('user_manual_pdf_nofetch', 
'compile_user_manual_pdf')
 
-        # Target for creating the HTML version of the user manual.
+        # Target for creating the user manual (HTML version).
         manual_env.Manual(target='user_manual_html', source=None)
         manual_env.Depends('user_manual_html', 'manual_clean')
         manual_env.Depends('user_manual_html', 'manual_version_file')
         manual_env.Depends('user_manual_html', 'fetch_docstrings')
         manual_env.Depends('user_manual_html', 'compile_user_manual_html')
 
-        # Target for creating the HTML version of the user manual (without 
fetching the docstrings).
+        # Target for creating the user manual (HTML version, without 
fetching the docstrings).
         manual_env.Manual(target='user_manual_html_nofetch', source=None)
         manual_env.Depends('user_manual_html_nofetch', 'manual_clean')
         manual_env.Depends('user_manual_html_nofetch', 'manual_version_file')
         manual_env.Depends('user_manual_html_nofetch', 
'compile_user_manual_html')
 
-        # Target for creating the HTML version of the API documentation 
manual.
+        # Target for creating the API documentation manual (HTML version).
         manual_env.Manual(target='api_manual_html', source=None)
         manual_env.Depends('api_manual_html', 'manual_clean')
         manual_env.Depends('api_manual_html', 'compile_api_manual_html')