summaryrefslogtreecommitdiff
path: root/sphinx/builders/htmlhelp.py
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2017-12-28 20:45:02 +0000
committerStephen Finucane <stephen@that.guru>2018-01-11 20:57:03 +0000
commita83e8bab7d03d209f76cc92ffe29a9b89289cf6f (patch)
tree23bd2051c8cc805ca1f8e3568014237c4edf8dae /sphinx/builders/htmlhelp.py
parentb1cea0258924840f8611e0301303fd18bcac82b0 (diff)
downloadsphinx-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/builders/htmlhelp.py')
-rw-r--r--sphinx/builders/htmlhelp.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/sphinx/builders/htmlhelp.py b/sphinx/builders/htmlhelp.py
index 0b45601e3..63fba05f3 100644
--- a/sphinx/builders/htmlhelp.py
+++ b/sphinx/builders/htmlhelp.py
@@ -174,6 +174,8 @@ class HTMLHelpBuilder(StandaloneHTMLBuilder):
index files. Adapted from the original Doc/tools/prechm.py.
"""
name = 'htmlhelp'
+ epilog = ('You can now run HTML Help Workshop with the .htp file in '
+ '%(outdir)s.')
# don't copy the reST source
copysource = False