Attachment 920323 Details for Bug 1122654 – patch to prevent timestamp in docs

[patch] patch to prevent timestamp in docs

epydoc-3.0.1-don-t-add-timestamp-to-footer.patch (text/plain), 6.60 KB, created by Benedikt Morbach on 2014-07-23 17:14:48 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Benedikt Morbach

Created: 2014-07-23 17:14:48 UTC

Size: 6.60 KB

patch

obsolete

>From 3edfe6a192ac2541ff1e3cf042bfd44129899d82 Mon Sep 17 00:00:00 2001
>From: Benedikt Morbach <bmorbach@redhat.com>
>Date: Wed, 23 Jul 2014 18:02:53 +0200
>Subject: [PATCH] don't add timestamp to footer
>
>add option to include timestamp
>---
> doc/manual-usage.txt | 4 ++--
> doc/using.html | 5 +++--
> man/epydoc.1 | 4 ++++
> epydoc/cli.py | 7 +++++++
> epydoc/docwriter/html.py | 14 ++++++++++++--
> epydoc/docwriter/html_css.py | 4 ++--
> epydoc/docwriter/html_help.py | 4 ++--
> 7 files changed, 32 insertions(+), 10 deletions(-)
>
>diff --git a/doc/using.html b/doc/using.html
>index 82c4bf5..76d8a0e 100644
>--- a/doc/using.html
>+++ b/doc/using.html
>@@ -384,8 +384,9 @@ class directly. 
> <li><code>epydoc-log.html</code>
> A page with the log of the epydoc execution. It is available clicking on the
> timestamp below each page, if the documentation was created using the
>- <code>--include-log</code> option. The page also contains the list of the
>- options enabled when the documentation was created. </li>
>+ <code>--include-log</code> and <code>--include-timestamp</code> options.
>+ The page also contains the list of the options enabled when the documentation
>+ was created. </li>
> 
> <li><code>api-objects.txt</code>
> A text file containing each available item and the URL where it is
>diff --git a/man/epydoc.1 b/man/epydoc.1
>index cbe5abc..0beb547 100644
>--- a/man/epydoc.1
>+++ b/man/epydoc.1
>@@ -293,6 +293,10 @@ documentation, instead of including them in the documentation for
> 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.
>+.\" --include-timestamp
>+.TP
>+.B \-\-include\-timestamp
>+Include a timestamp in the generated output.
> .RE
> .PP
> .\"--------------------------------------------------
>diff --git a/epydoc/cli.py b/epydoc/cli.py
>index c9beb57..aecd6e3 100644
>--- a/epydoc/cli.py
>+++ b/epydoc/cli.py
>@@ -135,6 +135,7 @@ OPTION_DEFAULTS = dict(
> debug=epydoc.DEBUG, profile=False, graphs=[],
> list_classes_separately=False, graph_font=None, graph_font_size=None,
> include_source_code=True, pstat_files=[], simple_term=False, fail_on=None,
>+ include_timestamp=False,
> exclude=[], exclude_parse=[], exclude_introspect=[],
> external_api=[], external_api_file=[], external_api_root=[],
> redundant_details=False, src_code_tab_width=8)
>@@ -343,6 +344,10 @@ def parse_arguments():
> help=("When generating HTML output, sets the number of spaces "
> "each tab in source code listings is replaced with."))
> 
>+ output_group.add_option('--include-timestamp',
>+ action='store_true', dest='include_timestamp',
>+ help=("Include a timestamp in the generated output."))
>+
> # The group of external API options.
> # Skip if the module couldn't be imported (usually missing docutils)
> if xlink is not None:
>@@ -580,6 +585,8 @@ def parse_configfiles(configfiles, options, names):
> 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'):
>diff --git a/epydoc/docwriter/html.py b/epydoc/docwriter/html.py
>index d979455..ea7220f 100644
>--- a/epydoc/docwriter/html.py
>+++ b/epydoc/docwriter/html.py
>@@ -291,6 +291,9 @@ class HTMLWriter:
> @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 @@ class HTMLWriter:
> self._include_log = kwargs.get('include_log', False)
> """Are we generating an HTML log page?"""
> 
>+ self._include_timestamp = kwargs.get('include_timestamp', False)
>+ """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 @@ class HTMLWriter:
> <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">
>diff --git a/epydoc/docwriter/html_css.py b/epydoc/docwriter/html_css.py
>index 623ade9..da8df87 100644
>--- a/epydoc/docwriter/html_css.py
>+++ b/epydoc/docwriter/html_css.py
>@@ -82,8 +82,8 @@ a.link { font-family: monospace; }
> * variables and to show/hide frames; and a page title (using
> * <h1>). The page title may be followed by a link to the
> * corresponding source code (using 'span.codelink').
>- * - The footer consists of a navigation bar, a timestamp, and a
>- * pointer to epydoc's homepage.
>+ * - The footer consists of a navigation bar, a timestamp
>+ * (if --include-timestamp was passed), and a pointer to epydoc's homepage.
> */ 
> h1.epydoc { margin: 0; font-size: +140%; font-weight: bold; }
> h2.epydoc { font-size: +130%; font-weight: bold; }
>diff --git a/epydoc/docwriter/html_help.py b/epydoc/docwriter/html_help.py
>index 92653b4..50b02a1 100644
>--- a/epydoc/docwriter/html_help.py
>+++ b/epydoc/docwriter/html_help.py
>@@ -185,6 +185,6 @@ are private objects; but "<code>re.sub</code>",
> if a module defines the "<code>__all__</code>" variable, then its
> contents are used to decide which objects are private. 
> 
>- A timestamp below the bottom navigation bar indicates when each
>-page was last updated. 
>+ If --include-timestamp was passed, a timestamp below the bottom navigation bar indicates
>+when each page was last updated. 
> '''
>-- 
>1.9.3
>

Actions: View | Diff

Attachments on bug 1122654: 920323