7 Commits

Author	SHA1	Message	Date
Jorge Leitao	99f9209924	Add summary statistics to the coverage report (#5474) ... The current implementation of ``sphinx.ext.coverage`` outputs which methods,classes, and functions are documented. This commit adds a short summary of this report in terms of ``documented objects / total number of objects``, both per module and total. The purpose of this is to support a currently not mainstream but relevant use-case: a coverage report on the number of objects that are documented. By having the statistics on the report or on the stdout, a regex expression can capture the coverage percentage (e.g. ``re.search(r'TOTAL.*?([0-9.]{4,6}\%)', d).group(1)``) and use it e.g. in another report, a status badge, etc. Two options were added to the configuration to allow a table to be printed in the report and/or to stdout. Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2023-07-28 02:33:42 +01:00
François Freitag	5166dd194c	Strip trailing whitespaces and normalize line endings ... Trailing whitespace do not have impact on the result, they are just unused bytes. Most text editors are configured to strip trailing whitespaces. Remove them all in one go. Update a handful of files to use the UNIX line ending.	2020-10-03 13:47:01 +02:00
Takeshi KOMIYA	2fb5232b12	Fix typo	2020-06-06 01:21:35 +09:00
Christian Riedel	f33eb15b83	documented coverage_show_missing_items confval	2020-06-05 17:42:26 +02:00
Adrián Chaves	e84ba7f78a	Support coverage_ignore_pyobjects in the coverage builder	2019-05-15 12:23:05 +02:00
Takeshi KOMIYA	ceef713e79	docs: Remove a term "new" from config values	2019-02-27 01:18:57 +09:00
Stephen Finucane	d9ccc95717	doc: Add "extensions" to usage guide ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-06-20 09:30:47 +01:00