IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Takeshi KOMIYA 2018-01-29 22:40:49 +09:00
parent b924e06066
commit 0010179d45
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/extdev/builderapi.rst
View File

@ -17,6 +17,9 @@ Builder API
.. autoattribute:: format .. autoattribute:: format
.. autoattribute:: epilog .. autoattribute:: epilog
.. autoattribute:: supported_image_types .. 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: These methods are predefined and will be called from the application:

6
sphinx/builders/__init__.py
View File

@ -59,8 +59,8 @@ class Builder(object):
#: ``project`` #: ``project``
epilog = '' # type: unicode epilog = '' # type: unicode
# default translator class for the builder. This will be overrided by #: default translator class for the builder. This can be overrided by
# ``app.set_translator()``. #: :py:meth:`app.set_translator()`.
default_translator_class = None # type: nodes.NodeVisitor default_translator_class = None # type: nodes.NodeVisitor
# doctree versioning method # doctree versioning method
versioning_method = 'none' # type: unicode versioning_method = 'none' # type: unicode
@ -73,7 +73,9 @@ class Builder(object):
#: The list of MIME types of image formats supported by the builder. #: The list of MIME types of image formats supported by the builder.
#: Image files are searched in the order in which they appear here. #: Image files are searched in the order in which they appear here.
supported_image_types = [] # type: List[unicode] supported_image_types = [] # type: List[unicode]
#: The builder supports remote images or not.
supported_remote_images = False supported_remote_images = False
#: The builder supports data URIs or not.
supported_data_uri_images = False supported_data_uri_images = False
def __init__(self, app): def __init__(self, app):