diff options
author | Stephen Finucane <stephen@that.guru> | 2017-12-28 20:45:02 +0000 |
---|---|---|
committer | Stephen Finucane <stephen@that.guru> | 2018-01-11 20:57:03 +0000 |
commit | a83e8bab7d03d209f76cc92ffe29a9b89289cf6f (patch) | |
tree | 23bd2051c8cc805ca1f8e3568014237c4edf8dae /sphinx/ext/coverage.py | |
parent | b1cea0258924840f8611e0301303fd18bcac82b0 (diff) | |
download | sphinx-git-a83e8bab7d03d209f76cc92ffe29a9b89289cf6f.tar.gz |
builders: Add 'Builder.epilog' option
This allows builders to emit a final epilog message containing
information such as where resulting files can be found. This is only
emitted if the build was successful.
This allows us to remove this content from the 'make_mode' tool and
the legacy 'Makefile' and 'make.bat' templates. There's room for more
dramatic simplification of the former, but this will come later.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'sphinx/ext/coverage.py')
-rw-r--r-- | sphinx/ext/coverage.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py index 476a0ed46..74d004ad1 100644 --- a/sphinx/ext/coverage.py +++ b/sphinx/ext/coverage.py @@ -50,8 +50,12 @@ def compile_regex_list(name, exps): class CoverageBuilder(Builder): - + """ + Evaluates coverage of code in the documentation. + """ name = 'coverage' + epilog = ('Testing of coverage in the sources finished, look at the ' + 'results in %(outdir)s/python.txt.') def init(self): # type: () -> None |