diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2021-01-10 21:00:09 -0500 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2021-01-10 21:11:46 -0500 |
| commit | 46f4b1204f7dd270c96087bbbe351d842881096e (patch) | |
| tree | 6164452f48d42f9f5c73f18d0c54cf2fa9e8425e /doc | |
| parent | 69573662dab1203009075bca655eadf088aeda78 (diff) | |
| download | python-coveragepy-git-nedbat/html-skip-covered.tar.gz | |
skip_covered and skip_empty for HTML. #1090nedbat/html-skip-covered
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/doc/config.rst b/doc/config.rst index c6cb94dd..3a8b0784 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -315,16 +315,6 @@ setting also affects the interpretation of the ``fail_under`` setting. ``show_missing`` (boolean, default False): when running a summary report, show missing lines. See :ref:`cmd_report` for more information. -.. _config_report_skip_covered: - -``skip_covered`` (boolean, default False): Don't include files in the report -that are 100% covered files. See :ref:`cmd_report` for more information. - -.. _config_report_skip_empty: - -``skip_empty`` (boolean, default False): Don't include empty files (those that -have 0 statements) in the report. See :ref:`cmd_report` for more information. - .. _config_report_sort: ``sort`` (string, default "Name"): Sort the text report by the named column. @@ -344,18 +334,30 @@ also apply to HTML output, where appropriate. ``directory`` (string, default "htmlcov"): where to write the HTML report files. +.. _config_html_extra_css: + +``extra_css`` (string): the path to a file of CSS to apply to the HTML report. +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. + .. _config_html_show_context: ``show_contexts`` (boolean): should the HTML report include an indication on each line of which contexts executed the line. See :ref:`dynamic_contexts` for details. -.. _config_html_extra_css: +.. _config_html_skip_covered: -``extra_css`` (string): the path to a file of CSS to apply to the HTML report. -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. +``skip_covered`` (boolean, defaulted from ``[report] skip_covered``): Don't +include files in the report that are 100% covered files. See :ref:`cmd_report` +for more information. + +.. _config_html_skip_empty: + +``skip_empty`` (boolean, defaulted from ``[report] skip_empty``): Don't include +empty files (those that have 0 statements) in the report. See :ref:`cmd_report` +for more information. .. _config_html_title: |