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/devhelp.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/devhelp.py')
| -rw-r--r-- | sphinx/builders/devhelp.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/sphinx/builders/devhelp.py b/sphinx/builders/devhelp.py index 88a9be219..c5e9eb6ea 100644 --- a/sphinx/builders/devhelp.py +++ b/sphinx/builders/devhelp.py @@ -43,6 +43,10 @@ class DevhelpBuilder(StandaloneHTMLBuilder): Builder that also outputs GNOME Devhelp file. """ name = 'devhelp' + epilog = ('To view the help file:\n' + '$ mkdir -p $HOME/.local/share/devhelp/%(project)s\n' + '$ ln -s %(outdir)s $HOME/.local/share/devhelp/%(project)s\n' + '$ devhelp') # don't copy the reST source copysource = False |