[Epydoc-commits] SF.net SVN: epydoc: [1698] trunk/epydoc

[<ed...@us...>]

Revision: 1698
          http://epydoc.svn.sourceforge.net/epydoc/?rev=1698&view=rev
Author:   edloper
Date:     2008-01-30 17:09:38 -0800 (Wed, 30 Jan 2008)

Log Message:
-----------
- Added --suppress-timestamp option (sf feature request 1695848)

Modified Paths:
--------------
    trunk/epydoc/man/epydoc.1
    trunk/epydoc/src/epydoc/cli.py
    trunk/epydoc/src/epydoc/docwriter/html.py

Modified: trunk/epydoc/man/epydoc.1
===================================================================
--- trunk/epydoc/man/epydoc.1	2008-01-31 00:33:47 UTC (rev 1697)
+++ trunk/epydoc/man/epydoc.1	2008-01-31 01:09:38 UTC (rev 1698)
@@ -293,6 +293,10 @@
 their modules.  This creates a separate LaTeX file for each class, so
 it can also be useful if you want to include the documentation for one
 or two classes as sections of your own LaTeX document.
+.\" --suppress-timestamp
+.TP
+.B \-\-suppress\-timestamp
+Do not include a timestamp in the generated output.
 .RE
 .PP
 .\"--------------------------------------------------

Modified: trunk/epydoc/src/epydoc/cli.py
===================================================================
--- trunk/epydoc/src/epydoc/cli.py	2008-01-31 00:33:47 UTC (rev 1697)
+++ trunk/epydoc/src/epydoc/cli.py	2008-01-31 01:09:38 UTC (rev 1698)
@@ -137,7 +137,8 @@
     include_source_code=True, pstat_files=[], simple_term=False, fail_on=None,
     exclude=[], exclude_parse=[], exclude_introspect=[],
     external_api=[], external_api_file=[], external_api_root=[],
-    redundant_details=False, src_code_tab_width=8)
+    redundant_details=False, src_code_tab_width=8,
+    include_timestamp=True)
 
 def parse_arguments():
     # Construct the option parser.
@@ -342,6 +343,11 @@
         action='store', type='int', dest='src_code_tab_width',
         help=("When generating HTML output, sets the number of spaces "
               "each tab in source code listings is replaced with."))
+
+    output_group.add_option('--suppress-timestamp',
+        action='store_false', dest='include_timestamp',
+        help=("When generating HTML output, suppress the timestamp at "
+              "the bottom of each page."))
     
     # The group of external API options.
     # Skip if the module couldn't be imported (usually missing docutils)
@@ -580,6 +586,8 @@
             options.list_classes_separately = _str_to_bool(val, optname)
         elif optname in ('src-code-tab-width', 'src_code_tab_width'):
             options.src_code_tab_width = _str_to_int(val, optname)
+        elif optname == 'timestamp':
+            options.include_timestamp = _str_to_bool(val, optname)
 
         # External API
         elif optname in ('external-api', 'external_api'):

Modified: trunk/epydoc/src/epydoc/docwriter/html.py
===================================================================
--- trunk/epydoc/src/epydoc/docwriter/html.py	2008-01-31 00:33:47 UTC (rev 1697)
+++ trunk/epydoc/src/epydoc/docwriter/html.py	2008-01-31 01:09:38 UTC (rev 1698)
@@ -291,6 +291,9 @@
         @type include_log: C{boolean}
         @keyword include_log: If true, the the footer will include an
               href to the page 'epydoc-log.html'.
+        @type include_timestamp: C{boolean}
+        @keyword include_timestamp: If true, then include a timestamp in
+              the footer.
         @type src_code_tab_width: C{int}
         @keyword src_code_tab_width: Number of spaces to replace each tab
             with in source code listings.
@@ -358,6 +361,9 @@
         self._include_log = kwargs.get('include_log', False)
         """Are we generating an HTML log page?"""
 
+        self._include_timestamp = kwargs.get('include_timestamp', True)
+        """Include a timestamp on the generated docs?"""
+
         self._src_code_tab_width = kwargs.get('src_code_tab_width', 8)
         """Number of spaces to replace each tab with in source code
         listings."""
@@ -1771,9 +1777,13 @@
             <td align="left" class="footer">
         >>>   if self._include_log:
             <a href="epydoc-log.html">Generated by Epydoc
-            $epydoc.__version__$ on $time.asctime()$</a>
+            $epydoc.__version__$
+        >>>       if self._include_timestamp:
+            on $time.asctime()$</a>
         >>>   else:
-            Generated by Epydoc $epydoc.__version__$ on $time.asctime()$
+            Generated by Epydoc $epydoc.__version__$
+        >>>       if self._include_timestamp:
+            on $time.asctime()$
         >>>   #endif
             </td>
             <td align="right" class="footer">


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.