|
Athmane Madjoudj |
2ee2fc |
From f8337105832d7d22d22dc7dcdb00630f690ba9ab Mon Sep 17 00:00:00 2001
|
|
Athmane Madjoudj |
2ee2fc |
From: Benedikt Morbach <bmorbach@redhat.com>
|
|
Athmane Madjoudj |
2ee2fc |
Date: Wed, 23 Jul 2014 18:02:53 +0200
|
|
Athmane Madjoudj |
2ee2fc |
Subject: [PATCH] make --suppress-timestamp the default
|
|
Athmane Madjoudj |
2ee2fc |
|
|
Athmane Madjoudj |
2ee2fc |
add option to include timestamp
|
|
Athmane Madjoudj |
2ee2fc |
---
|
|
Athmane Madjoudj |
2ee2fc |
epydoc/doc/manual-usage.txt | 4 ++--
|
|
Athmane Madjoudj |
2ee2fc |
epydoc/doc/using.html | 5 +++--
|
|
Athmane Madjoudj |
2ee2fc |
epydoc/man/epydoc.1 | 6 +++++-
|
|
Athmane Madjoudj |
2ee2fc |
epydoc/src/epydoc/cli.py | 10 +++++++---
|
|
Athmane Madjoudj |
2ee2fc |
epydoc/src/epydoc/docwriter/html.py | 2 +-
|
|
Athmane Madjoudj |
2ee2fc |
epydoc/src/epydoc/docwriter/html_css.py | 4 ++--
|
|
Athmane Madjoudj |
2ee2fc |
epydoc/src/epydoc/docwriter/html_help.py | 4 ++--
|
|
Athmane Madjoudj |
2ee2fc |
7 files changed, 22 insertions(+), 13 deletions(-)
|
|
Athmane Madjoudj |
2ee2fc |
|
|
Athmane Madjoudj |
2ee2fc |
diff --git a/epydoc/doc/manual-usage.txt b/epydoc/doc/manual-usage.txt
|
|
Athmane Madjoudj |
2ee2fc |
index 5a845dc..575f212 100644
|
|
Athmane Madjoudj |
2ee2fc |
--- a/epydoc/doc/manual-usage.txt
|
|
Athmane Madjoudj |
2ee2fc |
+++ b/epydoc/doc/manual-usage.txt
|
|
Athmane Madjoudj |
2ee2fc |
@@ -307,8 +307,8 @@ The following list describes each of the files generated by epydoc:
|
|
Athmane Madjoudj |
2ee2fc |
``epydoc-log.html``
|
|
Athmane Madjoudj |
2ee2fc |
A page with the log of the epydoc execution. It is available clicking on
|
|
Athmane Madjoudj |
2ee2fc |
the timestamp below each page, if the documentation was created using the
|
|
Athmane Madjoudj |
2ee2fc |
- ``--include-log`` option. The page also contains the list of the options
|
|
Athmane Madjoudj |
2ee2fc |
- enabled when the documentation was created.
|
|
Athmane Madjoudj |
2ee2fc |
+ ``--include-log`` and ``--include-timestamp`` options. The page also
|
|
Athmane Madjoudj |
2ee2fc |
+ contains the list of the options enabled when the documentation was created.
|
|
Athmane Madjoudj |
2ee2fc |
|
|
Athmane Madjoudj |
2ee2fc |
``api-objects.txt``
|
|
Athmane Madjoudj |
2ee2fc |
A text file containing each available item and the URL where it is
|
|
Athmane Madjoudj |
2ee2fc |
diff --git a/epydoc/doc/using.html b/epydoc/doc/using.html
|
|
Athmane Madjoudj |
2ee2fc |
index 82c4bf5..76d8a0e 100644
|
|
Athmane Madjoudj |
2ee2fc |
--- a/epydoc/doc/using.html
|
|
Athmane Madjoudj |
2ee2fc |
+++ b/epydoc/doc/using.html
|
|
Athmane Madjoudj |
2ee2fc |
@@ -384,8 +384,9 @@ class directly.
|
|
Athmane Madjoudj |
2ee2fc |
epydoc-log.html
|
|
Athmane Madjoudj |
2ee2fc |
A page with the log of the epydoc execution. It is available clicking on the
|
|
Athmane Madjoudj |
2ee2fc |
timestamp below each page, if the documentation was created using the
|
|
Athmane Madjoudj |
2ee2fc |
- --include-log option. The page also contains the list of the
|
|
Athmane Madjoudj |
2ee2fc |
- options enabled when the documentation was created.
|
|
Athmane Madjoudj |
2ee2fc |
+ --include-log and --include-timestamp options.
|
|
Athmane Madjoudj |
2ee2fc |
+ The page also contains the list of the options enabled when the documentation
|
|
Athmane Madjoudj |
2ee2fc |
+ was created.
|
|
Athmane Madjoudj |
2ee2fc |
|
|
Athmane Madjoudj |
2ee2fc |
api-objects.txt
|
|
Athmane Madjoudj |
2ee2fc |
A text file containing each available item and the URL where it is
|
|
Athmane Madjoudj |
2ee2fc |
diff --git a/epydoc/man/epydoc.1 b/epydoc/man/epydoc.1
|
|
Athmane Madjoudj |
2ee2fc |
index 5fbfcf9..4d527dc 100644
|
|
Athmane Madjoudj |
2ee2fc |
--- a/epydoc/man/epydoc.1
|
|
Athmane Madjoudj |
2ee2fc |
+++ b/epydoc/man/epydoc.1
|
|
Athmane Madjoudj |
2ee2fc |
@@ -293,10 +293,14 @@ documentation, instead of including them in the documentation for
|
|
Athmane Madjoudj |
2ee2fc |
their modules. This creates a separate LaTeX file for each class, so
|
|
Athmane Madjoudj |
2ee2fc |
it can also be useful if you want to include the documentation for one
|
|
Athmane Madjoudj |
2ee2fc |
or two classes as sections of your own LaTeX document.
|
|
Athmane Madjoudj |
2ee2fc |
+.\" --include-timestamp
|
|
Athmane Madjoudj |
2ee2fc |
+.TP
|
|
Athmane Madjoudj |
2ee2fc |
+.B \-\-include\-timestamp
|
|
Athmane Madjoudj |
2ee2fc |
+Include a timestamp in the generated output.
|
|
Athmane Madjoudj |
2ee2fc |
.\" --suppress-timestamp
|
|
Athmane Madjoudj |
2ee2fc |
.TP
|
|
Athmane Madjoudj |
2ee2fc |
.B \-\-suppress\-timestamp
|
|
Athmane Madjoudj |
2ee2fc |
-Do not include a timestamp in the generated output.
|
|
Athmane Madjoudj |
2ee2fc |
+ignored, only exists for backwards compatibility. (it is now the default)
|
|
Athmane Madjoudj |
2ee2fc |
.RE
|
|
Athmane Madjoudj |
2ee2fc |
.PP
|
|
Athmane Madjoudj |
2ee2fc |
.\"--------------------------------------------------
|
|
Athmane Madjoudj |
2ee2fc |
diff --git a/epydoc/src/epydoc/cli.py b/epydoc/src/epydoc/cli.py
|
|
Athmane Madjoudj |
2ee2fc |
index d7a308c..fbbe5de 100644
|
|
Athmane Madjoudj |
2ee2fc |
--- a/epydoc/src/epydoc/cli.py
|
|
Athmane Madjoudj |
2ee2fc |
+++ b/epydoc/src/epydoc/cli.py
|
|
Athmane Madjoudj |
2ee2fc |
@@ -152,7 +152,7 @@ def option_defaults():
|
|
Athmane Madjoudj |
2ee2fc |
fail_on=None, exclude=[], exclude_parse=[], exclude_introspect=[],
|
|
Athmane Madjoudj |
2ee2fc |
external_api=[], external_api_file=[], external_api_root=[],
|
|
Athmane Madjoudj |
2ee2fc |
redundant_details=False, src_code_tab_width=8, verbosity=0,
|
|
Athmane Madjoudj |
2ee2fc |
- include_timestamp=True, target={}, default_target=None,
|
|
Athmane Madjoudj |
2ee2fc |
+ include_timestamp=False, target={}, default_target=None,
|
|
Athmane Madjoudj |
2ee2fc |
pdfdriver='auto', show_submodule_list=True, inherit_from_object=False)
|
|
Athmane Madjoudj |
2ee2fc |
|
|
Athmane Madjoudj |
2ee2fc |
# append_const is not defined in py2.3 or py2.4, so use a callback
|
|
Athmane Madjoudj |
2ee2fc |
@@ -404,9 +404,13 @@ def parse_arguments():
|
|
Athmane Madjoudj |
2ee2fc |
help=("When generating HTML output, sets the number of spaces "
|
|
Athmane Madjoudj |
2ee2fc |
"each tab in source code listings is replaced with."))
|
|
Athmane Madjoudj |
2ee2fc |
|
|
Athmane Madjoudj |
2ee2fc |
+ output_group.add_option('--include-timestamp',
|
|
Athmane Madjoudj |
2ee2fc |
+ action='store_true', dest='include_timestamp',
|
|
Athmane Madjoudj |
2ee2fc |
+ help=("Include a timestamp in the generated output."))
|
|
Athmane Madjoudj |
2ee2fc |
+
|
|
Athmane Madjoudj |
2ee2fc |
output_group.add_option('--suppress-timestamp',
|
|
Athmane Madjoudj |
2ee2fc |
- action='store_false', dest='include_timestamp',
|
|
Athmane Madjoudj |
2ee2fc |
- help=("Do not include a timestamp in the generated output."))
|
|
Athmane Madjoudj |
2ee2fc |
+ action='store_false', dest='ignored_options',
|
|
Athmane Madjoudj |
2ee2fc |
+ help=("Ignored, only exists for backwards compatibility. (this is now the default)"))
|
|
Athmane Madjoudj |
2ee2fc |
|
|
Athmane Madjoudj |
2ee2fc |
# The group of external API options.
|
|
Athmane Madjoudj |
2ee2fc |
# Skip if the module couldn't be imported (usually missing docutils)
|
|
Athmane Madjoudj |
2ee2fc |
diff --git a/epydoc/src/epydoc/docwriter/html.py b/epydoc/src/epydoc/docwriter/html.py
|
|
Athmane Madjoudj |
2ee2fc |
index b6be5f4..e496f56 100644
|
|
Athmane Madjoudj |
2ee2fc |
--- a/epydoc/src/epydoc/docwriter/html.py
|
|
Athmane Madjoudj |
2ee2fc |
+++ b/epydoc/src/epydoc/docwriter/html.py
|
|
Athmane Madjoudj |
2ee2fc |
@@ -361,7 +361,7 @@ class HTMLWriter:
|
|
Athmane Madjoudj |
2ee2fc |
self._include_log = kwargs.get('include_log', False)
|
|
Athmane Madjoudj |
2ee2fc |
"""Are we generating an HTML log page?"""
|
|
Athmane Madjoudj |
2ee2fc |
|
|
Athmane Madjoudj |
2ee2fc |
- self._include_timestamp = kwargs.get('include_timestamp', True)
|
|
Athmane Madjoudj |
2ee2fc |
+ self._include_timestamp = kwargs.get('include_timestamp', False)
|
|
Athmane Madjoudj |
2ee2fc |
"""Include a timestamp on the generated docs?"""
|
|
Athmane Madjoudj |
2ee2fc |
|
|
Athmane Madjoudj |
2ee2fc |
self._src_code_tab_width = kwargs.get('src_code_tab_width', 8)
|
|
Athmane Madjoudj |
2ee2fc |
diff --git a/epydoc/src/epydoc/docwriter/html_css.py b/epydoc/src/epydoc/docwriter/html_css.py
|
|
Athmane Madjoudj |
2ee2fc |
index 53923aa..9b0c837 100644
|
|
Athmane Madjoudj |
2ee2fc |
--- a/epydoc/src/epydoc/docwriter/html_css.py
|
|
Athmane Madjoudj |
2ee2fc |
+++ b/epydoc/src/epydoc/docwriter/html_css.py
|
|
Athmane Madjoudj |
2ee2fc |
@@ -82,8 +82,8 @@ a.link { font-family: monospace; }
|
|
Athmane Madjoudj |
2ee2fc |
* variables and to show/hide frames; and a page title (using
|
|
Athmane Madjoudj |
2ee2fc |
* ). The page title may be followed by a link to the
|
|
Athmane Madjoudj |
2ee2fc |
* corresponding source code (using 'span.codelink').
|
|
Athmane Madjoudj |
2ee2fc |
- * - The footer consists of a navigation bar, a timestamp, and a
|
|
Athmane Madjoudj |
2ee2fc |
- * pointer to epydoc's homepage.
|
|
Athmane Madjoudj |
2ee2fc |
+ * - The footer consists of a navigation bar, a timestamp
|
|
Athmane Madjoudj |
2ee2fc |
+ * (if --include-timestamp was passed), and a pointer to epydoc's homepage.
|
|
Athmane Madjoudj |
2ee2fc |
*/
|
|
Athmane Madjoudj |
2ee2fc |
h1.epydoc { margin: 0; font-size: +140%; font-weight: bold; }
|
|
Athmane Madjoudj |
2ee2fc |
h2.epydoc { font-size: +130%; font-weight: bold; }
|
|
Athmane Madjoudj |
2ee2fc |
diff --git a/epydoc/src/epydoc/docwriter/html_help.py b/epydoc/src/epydoc/docwriter/html_help.py
|
|
Athmane Madjoudj |
2ee2fc |
index 92653b4..50b02a1 100644
|
|
Athmane Madjoudj |
2ee2fc |
--- a/epydoc/src/epydoc/docwriter/html_help.py
|
|
Athmane Madjoudj |
2ee2fc |
+++ b/epydoc/src/epydoc/docwriter/html_help.py
|
|
Athmane Madjoudj |
2ee2fc |
@@ -185,6 +185,6 @@ are private objects; but "re.sub ",
|
|
Athmane Madjoudj |
2ee2fc |
if a module defines the "__all__ " variable, then its
|
|
Athmane Madjoudj |
2ee2fc |
contents are used to decide which objects are private.
|
|
Athmane Madjoudj |
2ee2fc |
|
|
Athmane Madjoudj |
2ee2fc |
- A timestamp below the bottom navigation bar indicates when each
|
|
Athmane Madjoudj |
2ee2fc |
-page was last updated.
|
|
Athmane Madjoudj |
2ee2fc |
+ If --include-timestamp was passed, a timestamp below the bottom navigation bar indicates
|
|
Athmane Madjoudj |
2ee2fc |
+when each page was last updated.
|
|
Athmane Madjoudj |
2ee2fc |
'''
|
|
Athmane Madjoudj |
2ee2fc |
--
|
|
Athmane Madjoudj |
2ee2fc |
1.9.3
|
|
Athmane Madjoudj |
2ee2fc |
|