summaryrefslogtreecommitdiff
path: root/coverage/control.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2012-04-20 17:37:11 -0400
committerNed Batchelder <ned@nedbatchelder.com>2012-04-20 17:37:11 -0400
commit78e2c8c6e014b205e5f2cf7764ca9cf3597b318a (patch)
tree99dcb9b259c8c343e1623c705dda50201b7b0d82 /coverage/control.py
parent886c61c219b68dd66103a8c05f96ae9bf6b82ad6 (diff)
downloadpython-coveragepy-git-78e2c8c6e014b205e5f2cf7764ca9cf3597b318a.tar.gz
The [html]extra_css configuration value is a file path to a CSS file that gets copied into the HTML report.
Diffstat (limited to 'coverage/control.py')
-rw-r--r--coverage/control.py11
1 files changed, 9 insertions, 2 deletions
diff --git a/coverage/control.py b/coverage/control.py
index 7373b316..c21d885e 100644
--- a/coverage/control.py
+++ b/coverage/control.py
@@ -582,15 +582,22 @@ class coverage(object):
reporter.report(morfs, directory=directory)
def html_report(self, morfs=None, directory=None, ignore_errors=None,
- omit=None, include=None):
+ omit=None, include=None, extra_css=None):
"""Generate an HTML report.
+ The HTML is written to `directory`. The file "index.html" is the
+ overview starting point, with links to more detailed pages for
+ individual modules.
+
+ `extra_css` is a path to a file of other CSS to apply on the page.
+ It will be copied into the HTML directory.
+
See `coverage.report()` for other arguments.
"""
self.config.from_args(
ignore_errors=ignore_errors, omit=omit, include=include,
- html_dir=directory,
+ html_dir=directory, extra_css=extra_css,
)
reporter = HtmlReporter(self, self.config)
reporter.report(morfs)