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/builders/applehelp.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/builders/applehelp.py')
| -rw-r--r-- | sphinx/builders/applehelp.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/sphinx/builders/applehelp.py b/sphinx/builders/applehelp.py index 52ba2ce5c..0426be331 100644 --- a/sphinx/builders/applehelp.py +++ b/sphinx/builders/applehelp.py @@ -75,6 +75,10 @@ class AppleHelpBuilder(StandaloneHTMLBuilder): on the ``hiutil`` command line tool. """ name = 'applehelp' + epilog = ('The help book is in %(outdir)s.\n' + 'Note that won\'t be able to view it unless you put it in ' + '~/Library/Documentation/Help or install it in your application ' + 'bundle.') # don't copy the reST source copysource = False |