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

..

certs

linkcheck: Specify subjectAltName in test self-signed certificate

2020-11-15 18:25:39 +01:00

js

Split out sphinx_highlight.js

2022-09-24 15:10:57 +01:00

roots

Drop support for Python 3.8 (#11511)

2023-07-25 02:07:23 +01:00

__init__.py

Make tests/ a Python package

2020-11-20 19:43:02 +01:00

conftest.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

ext_napoleon_pep526_data_google.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

ext_napoleon_pep526_data_numpy.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_api_translator.py

Fix pytest style issues

2023-02-18 02:16:50 +00:00

test_application.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_build_changes.py

.read_text() -> .read_text(encoding='utf8')

2022-04-27 03:04:19 +01:00

test_build_dirhtml.py

Fix various Ruff errors

2023-01-31 18:30:43 +00:00

test_build_epub.py

Fix instability in `test_build_epub` (#11296)

2023-04-06 22:33:20 +01:00

test_build_gettext.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_build_html.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_build_latex.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_build_linkcheck.py

Enable skipping anchor verification on a per-URL basis (#11489)

2023-07-24 12:15:42 +01:00

test_build_manpage.py

Revert "Fix detection for out of date files (#9360)" (#10908)

2022-10-13 13:16:17 +01:00

test_build_texinfo.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_build_text.py

.read_text() -> .read_text(encoding='utf8')

2022-04-27 03:04:19 +01:00

test_build.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_builder.py

.write_text(...) -> .write_text(..., encoding='utf8')

2022-04-27 03:11:08 +01:00

test_catalogs.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_config.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_correct_year.py

Fix pytest style issues

2023-02-18 02:16:50 +00:00

test_directive_code.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_directive_object_description.py

Add `content_offset parameter to nested_parse_with_titles` (#11147)

2023-02-15 05:45:28 +00:00

test_directive_only.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_directive_other.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_directive_patch.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_docutilsconf.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_domain_c.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_domain_cpp.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_domain_js.py

Allow multi-line object description signatures (#11011)

2023-05-11 14:28:57 +01:00

test_domain_py.py

Support PEP 695 and PEP 696 syntax in the Python domain (#11444)

2023-07-23 23:22:40 +01:00

test_domain_rst.py

Adopt `profile = "black" for isort`

2023-01-07 18:31:15 +00:00

test_domain_std.py

Adopt `profile = "black" for isort`

2023-01-07 18:31:15 +00:00

test_environment_indexentries.py

Warn on deprecated Python-specific index types (#11412)

2023-05-09 22:57:39 +01:00

test_environment_record_dependencies.py

Clear record_dependencies for each document (#10855)

2022-09-24 00:31:26 +01:00

test_environment_toctree.py

Warn on deprecated Python-specific index types (#11412)

2023-05-09 22:57:39 +01:00

test_environment.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_errors.py

Drop python 3.6 support (#10468)

2022-06-16 19:33:55 +01:00

test_events.py

Fix typos found by codespell

2023-03-27 07:22:07 +02:00

test_ext_apidoc.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_ext_autodoc_autoattribute.py

Document `typing.NewType` as a class (#10700)

2023-01-02 18:57:04 +00:00

test_ext_autodoc_autoclass.py

Drop support for Python 3.8 (#11511)

2023-07-25 02:07:23 +01:00

test_ext_autodoc_autodata.py

Document `typing.NewType` as a class (#10700)

2023-01-02 18:57:04 +00:00

test_ext_autodoc_autofunction.py

Drop python 3.6 support (#10468)

2022-06-16 19:33:55 +01:00

test_ext_autodoc_automodule.py

Merge branch '5.x'

2022-09-23 17:27:00 +01:00

test_ext_autodoc_autoproperty.py

Support type comments in `PropertyDocumenter` (#11298)

2023-04-06 22:56:17 +01:00

test_ext_autodoc_configs.py

Use `overwrite_file context manager in test_ext_autodoc_configs` (#11320)

2023-04-21 02:44:11 +01:00

test_ext_autodoc_events.py

Resolve `flake8-return` errors

2023-02-18 02:16:50 +00:00

test_ext_autodoc_mock.py

Insert `from __future__ import annotations`

2023-01-01 20:48:37 +00:00

test_ext_autodoc_preserve_defaults.py

Drop Python 3.7

2022-09-27 18:31:47 +01:00

test_ext_autodoc_private_members.py

Add test cases for #8180

2022-05-23 02:04:03 +09:00

test_ext_autodoc.py

Drop support for Python 3.8 (#11511)

2023-07-25 02:07:23 +01:00

test_ext_autosectionlabel.py

Show the repr of the value in some warnings (#10439)

2022-06-16 21:07:25 +01:00

test_ext_autosummary.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_ext_coverage.py

Add summary statistics to the coverage report (#5474)

2023-07-28 02:33:42 +01:00

test_ext_doctest.py

Enable mypy 'strict optional' for 19 modules (#11422)

2023-07-23 21:29:04 +01:00

test_ext_duration.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_ext_extlinks.py

Don't display 'replaceable hardcoded link' when link has a slash (#10137)

2022-10-05 14:47:16 +01:00

test_ext_githubpages.py

.read_text() -> .read_text(encoding='utf8')

2022-04-27 03:04:19 +01:00

test_ext_graphviz.py

Increase minimum Docutils to 0.17

2022-09-27 18:31:47 +01:00

test_ext_ifconfig.py

Add `content_offset parameter to nested_parse_with_titles` (#11147)

2023-02-15 05:45:28 +00:00

test_ext_imgconverter.py

Fix pytest style issues

2023-02-18 02:16:50 +00:00

test_ext_imgmockconverter.py

Add unit test for issue #11110 as fixed by #11113

2023-04-03 18:26:34 +02:00

test_ext_inheritance_diagram.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_ext_intersphinx.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_ext_math.py

Cache doctrees more efficiently

2023-01-04 05:46:23 +00:00

test_ext_napoleon_docstring.py

Fix pytest style issues

2023-02-18 02:16:50 +00:00

test_ext_napoleon.py

Avoid `unittest.TestCase` methods

2023-02-18 02:05:14 +00:00

test_ext_todo.py

.read_text() -> .read_text(encoding='utf8')

2022-04-27 03:04:19 +01:00

test_ext_viewcode.py

Fix instability in `test_ext_viewcode` (#11297)

2023-04-06 22:40:33 +01:00

test_extension.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_highlighting.py

Include source in highlighting warnings (#11150)

2023-03-17 15:32:27 +00:00

test_intl.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_locale.py

Partially revert "Disable localisation when SOURCE_DATE_EPOCH is set (#10949)" (#11343)

2023-04-21 19:04:26 +01:00

test_markup.py

Prefer `@pytest.fixture()`

2023-02-18 01:58:05 +00:00

test_metadata.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_parser.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_project.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_pycode_ast.py

Drop Python 3.7

2022-09-27 18:31:47 +01:00

test_pycode_parser.py

Remove traces of Python 2 and 3.5 (#10560)

2022-06-16 21:37:46 +01:00

test_pycode.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_quickstart.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_roles.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_search.py

Allow parallel execution of tests in `test_search` (#11292)

2023-04-05 13:54:09 +01:00

test_smartquotes.py

Increase minimum Docutils to 0.18

2022-09-27 18:31:47 +01:00

test_templating.py

.read_text() -> .read_text(encoding='utf8')

2022-04-27 03:04:19 +01:00

test_theming.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_toctree.py

.write_text(...) -> .write_text(..., encoding='utf8')

2022-04-27 03:11:08 +01:00

test_transforms_post_transforms_code.py

.read_text() -> .read_text(encoding='utf8')

2022-04-27 03:04:19 +01:00

test_transforms_post_transforms.py

Review comments

2022-06-01 18:10:55 +01:00

test_util_display.py

Refactor `status_iterator`

2023-05-15 10:43:55 +01:00

test_util_docstrings.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_util_docutils.py

Adopt `profile = "black" for isort`

2023-01-07 18:31:15 +00:00

test_util_fileutil.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_util_i18n.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_util_images.py

Fix pytest style issues

2023-02-18 02:16:50 +00:00

test_util_inspect.py

Refactor `sphinx.util.inspect` and tests (#11527)

2023-07-28 02:05:40 +01:00

test_util_inventory.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_util_logging.py

Fix pytest style issues

2023-02-18 02:16:50 +00:00

test_util_matching.py

Update include_patterns implementation (#10680)

2022-07-23 21:19:35 +01:00

test_util_nodes.py

Fix COM812

2023-02-18 01:58:05 +00:00

test_util_rst.py

Allow using `rst_prolog` with a role in a document title (#11445)

2023-07-23 17:14:01 +01:00

test_util_template.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

test_util_typing.py

Drop support for Python 3.8 (#11511)

2023-07-25 02:07:23 +01:00

test_util.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_versioning.py

Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526)

2023-07-28 00:39:12 +01:00

test_writer_latex.py

Collapse single line docstrings

2022-02-20 03:13:45 +00:00

typing_test_data.py

Drop support for Python 3.8 (#11511)

2023-07-25 02:07:23 +01:00

utils.py

Use HTTP/1.1 in linkcheck test webservers (#11392)

2023-07-22 20:12:32 +01:00