summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2012-11-09 21:34:42 -0500
committerNed Batchelder <ned@nedbatchelder.com>2012-11-09 21:34:42 -0500
commit99fee9149a879b786d1974115d5c8afc43a21d08 (patch)
tree78002675350b6b31fe0a351266bd2c68555de5b3 /doc
parentf683ba3af6c539882dd0b4f750b476e2d9745ebe (diff)
downloadpython-coveragepy-99fee9149a879b786d1974115d5c8afc43a21d08.tar.gz
Now the title of the HTML report can be set.
Diffstat (limited to 'doc')
-rw-r--r--doc/cmd.rst12
-rw-r--r--doc/config.rst3
2 files changed, 11 insertions, 4 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index c15857c..e8e5f39 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -274,13 +274,17 @@ Lines are highlighted green for executed, red for missing, and gray for
excluded. The counts at the top of the file are buttons to turn on and off
the highlighting.
-If you prefer a different style for your HTML report, you can provide your
-own CSS file to apply, by specifying a CSS file in the [html] section of the
-configuration file. See :ref:`config_html` for details.
-
A number of keyboard shortcuts are available for navigating the report.
Click the keyboard icon in the upper right to see the complete list.
+The title of the report can be set with the ``title`` setting in the
+``[html]`` section of the configuration file, or the ``--title`` switch on
+the command line.
+
+If you prefer a different style for your HTML report, you can provide your
+own CSS file to apply, by specifying a CSS file in the ``[html]`` section of
+the configuration file. See :ref:`config_html` for details.
+
The ``-d`` argument specifies an output directory, defaulting to "htmlcov"::
$ coverage html -d coverage_html
diff --git a/doc/config.rst b/doc/config.rst
index 74cab4f..159a42f 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -180,6 +180,9 @@ The file will be copied into the HTML output directory. Don't name it
"style.css". This CSS is in addition to the CSS normally used, though you can
overwrite as many of the rules as you like.
+``title`` (string, default "Coverage report"): the title to use for the report.
+Note this is text, not HTML.
+
[xml]
-----