diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-01-29 22:40:49 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-01-29 22:41:06 +0900 |
| commit | 0010179d45d110655b845f19810af3f44ae9c893 (patch) | |
| tree | 80e4f93cc011d37162326454d996b98ec6b6a3a4 | |
| parent | b924e0606646ecbc2c57e9826bb46589c836a3a4 (diff) | |
| download | sphinx-git-0010179d45d110655b845f19810af3f44ae9c893.tar.gz | |
docs: Add description for attributes of Builder (refs: #4402)
| -rw-r--r-- | doc/extdev/builderapi.rst | 3 | ||||
| -rw-r--r-- | sphinx/builders/__init__.py | 6 |
2 files changed, 7 insertions, 2 deletions
diff --git a/doc/extdev/builderapi.rst b/doc/extdev/builderapi.rst index b8ff0595b..2c2cf12e3 100644 --- a/doc/extdev/builderapi.rst +++ b/doc/extdev/builderapi.rst @@ -17,6 +17,9 @@ Builder API .. autoattribute:: format .. autoattribute:: epilog .. autoattribute:: supported_image_types + .. autoattribute:: supported_remote_images + .. autoattribute:: supported_data_uri_images + .. autoattribute:: default_translator_class These methods are predefined and will be called from the application: diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index 51578a1d6..662b94227 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -59,8 +59,8 @@ class Builder(object): #: ``project`` epilog = '' # type: unicode - # default translator class for the builder. This will be overrided by - # ``app.set_translator()``. + #: default translator class for the builder. This can be overrided by + #: :py:meth:`app.set_translator()`. default_translator_class = None # type: nodes.NodeVisitor # doctree versioning method versioning_method = 'none' # type: unicode @@ -73,7 +73,9 @@ class Builder(object): #: The list of MIME types of image formats supported by the builder. #: Image files are searched in the order in which they appear here. supported_image_types = [] # type: List[unicode] + #: The builder supports remote images or not. supported_remote_images = False + #: The builder supports data URIs or not. supported_data_uri_images = False def __init__(self, app): |