docs: Add description for attributes of Builder (refs: sphinx-doc#4402)

tk0miya · Jan 29, 2018 · 0010179 · 0010179
1 parent b924e06
commit 0010179
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git 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
@@ -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):