summaryrefslogtreecommitdiff
path: root/doc/extdev
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 /doc/extdev
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 'doc/extdev')
-rw-r--r--doc/extdev/builderapi.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/extdev/builderapi.rst b/doc/extdev/builderapi.rst
index 668f46698..b8ff0595b 100644
--- a/doc/extdev/builderapi.rst
+++ b/doc/extdev/builderapi.rst
@@ -15,6 +15,7 @@ Builder API
.. autoattribute:: name
.. autoattribute:: format
+ .. autoattribute:: epilog
.. autoattribute:: supported_image_types
These methods are predefined and will be called from the application: