IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add `doctest_show_success option to sphinx.ext.doctest` (#10938)

Browse Source 
For documentation that includes *many* doctests,
seeing both successes and failures can add a lot of noise to the command output.

This change adds a ``doctest_show_success`` option that,
when set to ``False``, will only show doctest failures.
This commit is contained in:
Trey Hunner
2023-07-28 14:16:38 -07:00
committed by GitHub
parent d1b09b04c2
commit aef5445153
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
sphinx/ext/doctest.py
View File

@@ -454,8 +454,9 @@ Doctest summary
if not groups:
return
self._out('\nDocument: %s\n----------%s\n' %
(docname, '-' * len(docname)))
if self.config.doctest_show_successes:
self._out('\nDocument: %s\n----------%s\n' %
(docname, '-' * len(docname)))
for group in groups.values():
self.test_group(group)
# Separately count results from setup code
@@ -463,12 +464,13 @@ Doctest summary
self.setup_failures += res_f
self.setup_tries += res_t
if self.test_runner.tries:
res_f, res_t = self.test_runner.summarize(self._out, verbose=True)
res_f, res_t = self.test_runner.summarize(
self._out, verbose=self.config.doctest_show_successes)
self.total_failures += res_f
self.total_tries += res_t
if self.cleanup_runner.tries:
res_f, res_t = self.cleanup_runner.summarize(self._out,
verbose=True)
res_f, res_t = self.cleanup_runner.summarize(
self._out, verbose=self.config.doctest_show_successes)
self.cleanup_failures += res_f
self.cleanup_tries += res_t
@@ -555,6 +557,7 @@ def setup(app: Sphinx) -> dict[str, Any]:
app.add_directive('testoutput', TestoutputDirective)
app.add_builder(DocTestBuilder)
# this config value adds to sys.path
app.add_config_value('doctest_show_successes', True, False)
app.add_config_value('doctest_path', [], False)
app.add_config_value('doctest_test_doctest_blocks', 'default', False)
app.add_config_value('doctest_global_setup', '', False)