mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
builtin extensions return metadata to allow parallel build
This commit is contained in:
@@ -532,12 +532,6 @@ class Sphinx(object):
|
|||||||
# special-case for compatibility
|
# special-case for compatibility
|
||||||
if extension == 'rst2pdf.pdfbuilder':
|
if extension == 'rst2pdf.pdfbuilder':
|
||||||
ext_meta = {'parallel_read_safe': True}
|
ext_meta = {'parallel_read_safe': True}
|
||||||
elif extension in builtin_extensions:
|
|
||||||
ext_meta = {
|
|
||||||
'version': 'builtin',
|
|
||||||
'parallel_read_safe': True,
|
|
||||||
'parallel_write_safe': True,
|
|
||||||
}
|
|
||||||
try:
|
try:
|
||||||
if not ext_meta.get('version'):
|
if not ext_meta.get('version'):
|
||||||
ext_meta['version'] = 'unknown version'
|
ext_meta['version'] = 'unknown version'
|
||||||
|
|||||||
@@ -293,3 +293,9 @@ def setup(app):
|
|||||||
app.add_config_value('applehelp_indexer_path', '/usr/bin/hiutil', 'applehelp')
|
app.add_config_value('applehelp_indexer_path', '/usr/bin/hiutil', 'applehelp')
|
||||||
app.add_config_value('applehelp_codesign_path', '/usr/bin/codesign', 'applehelp')
|
app.add_config_value('applehelp_codesign_path', '/usr/bin/codesign', 'applehelp')
|
||||||
app.add_config_value('applehelp_disable_external_tools', False, None)
|
app.add_config_value('applehelp_disable_external_tools', False, None)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -156,3 +156,9 @@ class ChangesBuilder(Builder):
|
|||||||
|
|
||||||
def setup(app):
|
def setup(app):
|
||||||
app.add_builder(ChangesBuilder)
|
app.add_builder(ChangesBuilder)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -125,3 +125,9 @@ def setup(app):
|
|||||||
app.add_builder(DevhelpBuilder)
|
app.add_builder(DevhelpBuilder)
|
||||||
|
|
||||||
app.add_config_value('devhelp_basename', lambda self: make_filename(self.project), None)
|
app.add_config_value('devhelp_basename', lambda self: make_filename(self.project), None)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -38,3 +38,9 @@ class DummyBuilder(Builder):
|
|||||||
|
|
||||||
def setup(app):
|
def setup(app):
|
||||||
app.add_builder(DummyBuilder)
|
app.add_builder(DummyBuilder)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -829,3 +829,9 @@ def setup(app):
|
|||||||
app.add_config_value('epub_max_image_width', 0, 'env')
|
app.add_config_value('epub_max_image_width', 0, 'env')
|
||||||
app.add_config_value('epub_show_urls', 'inline', 'html')
|
app.add_config_value('epub_show_urls', 'inline', 'html')
|
||||||
app.add_config_value('epub_use_index', lambda self: self.html_use_index, 'html')
|
app.add_config_value('epub_use_index', lambda self: self.html_use_index, 'html')
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -281,3 +281,9 @@ def setup(app):
|
|||||||
app.add_config_value('epub3_description', None, 'epub3', string_classes)
|
app.add_config_value('epub3_description', None, 'epub3', string_classes)
|
||||||
app.add_config_value('epub3_contributor', None, 'epub3', string_classes)
|
app.add_config_value('epub3_contributor', None, 'epub3', string_classes)
|
||||||
app.add_config_value('epub3_page_progression_direction', None, 'epub3', string_classes)
|
app.add_config_value('epub3_page_progression_direction', None, 'epub3', string_classes)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -256,3 +256,9 @@ def setup(app):
|
|||||||
app.add_config_value('gettext_uuid', False, 'gettext')
|
app.add_config_value('gettext_uuid', False, 'gettext')
|
||||||
app.add_config_value('gettext_auto_build', True, 'env')
|
app.add_config_value('gettext_auto_build', True, 'env')
|
||||||
app.add_config_value('gettext_additional_targets', [], 'env')
|
app.add_config_value('gettext_additional_targets', [], 'env')
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -1254,3 +1254,9 @@ def setup(app):
|
|||||||
app.add_config_value('html_search_options', {}, 'html')
|
app.add_config_value('html_search_options', {}, 'html')
|
||||||
app.add_config_value('html_search_scorer', '', None)
|
app.add_config_value('html_search_scorer', '', None)
|
||||||
app.add_config_value('html_scaled_image_link', True, 'html')
|
app.add_config_value('html_scaled_image_link', True, 'html')
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -312,3 +312,9 @@ def setup(app):
|
|||||||
app.add_builder(HTMLHelpBuilder)
|
app.add_builder(HTMLHelpBuilder)
|
||||||
|
|
||||||
app.add_config_value('htmlhelp_basename', lambda self: make_filename(self.project), None)
|
app.add_config_value('htmlhelp_basename', lambda self: make_filename(self.project), None)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -304,3 +304,9 @@ def setup(app):
|
|||||||
None)
|
None)
|
||||||
# now deprecated - use latex_elements
|
# now deprecated - use latex_elements
|
||||||
app.add_config_value('latex_preamble', '', None)
|
app.add_config_value('latex_preamble', '', None)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -299,3 +299,9 @@ def setup(app):
|
|||||||
# Anchors starting with ! are ignored since they are
|
# Anchors starting with ! are ignored since they are
|
||||||
# commonly used for dynamic pages
|
# commonly used for dynamic pages
|
||||||
app.add_config_value('linkcheck_anchors_ignore', ["^!"], None)
|
app.add_config_value('linkcheck_anchors_ignore', ["^!"], None)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -99,3 +99,9 @@ def setup(app):
|
|||||||
'%s %s' % (self.project, self.release), [], 1)],
|
'%s %s' % (self.project, self.release), [], 1)],
|
||||||
None)
|
None)
|
||||||
app.add_config_value('man_show_urls', False, None)
|
app.add_config_value('man_show_urls', False, None)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -310,3 +310,9 @@ def setup(app):
|
|||||||
app.add_config_value('qthelp_basename', lambda self: make_filename(self.project), None)
|
app.add_config_value('qthelp_basename', lambda self: make_filename(self.project), None)
|
||||||
app.add_config_value('qthelp_theme', 'nonav', 'html')
|
app.add_config_value('qthelp_theme', 'nonav', 'html')
|
||||||
app.add_config_value('qthelp_theme_options', {}, 'html')
|
app.add_config_value('qthelp_theme_options', {}, 'html')
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -242,3 +242,9 @@ def setup(app):
|
|||||||
app.add_config_value('texinfo_domain_indices', True, None, [list])
|
app.add_config_value('texinfo_domain_indices', True, None, [list])
|
||||||
app.add_config_value('texinfo_show_urls', 'footnote', None)
|
app.add_config_value('texinfo_show_urls', 'footnote', None)
|
||||||
app.add_config_value('texinfo_no_detailmenu', False, None)
|
app.add_config_value('texinfo_no_detailmenu', False, None)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -74,3 +74,9 @@ def setup(app):
|
|||||||
|
|
||||||
app.add_config_value('text_sectionchars', '*=-~"+`', 'env')
|
app.add_config_value('text_sectionchars', '*=-~"+`', 'env')
|
||||||
app.add_config_value('text_newlines', 'unix', 'env')
|
app.add_config_value('text_newlines', 'unix', 'env')
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -169,3 +169,9 @@ class WebSupportBuilder(PickleHTMLBuilder):
|
|||||||
|
|
||||||
def setup(app):
|
def setup(app):
|
||||||
app.add_builder(WebSupportBuilder)
|
app.add_builder(WebSupportBuilder)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -102,3 +102,9 @@ def setup(app):
|
|||||||
app.add_builder(PseudoXMLBuilder)
|
app.add_builder(PseudoXMLBuilder)
|
||||||
|
|
||||||
app.add_config_value('xml_pretty', True, 'env')
|
app.add_config_value('xml_pretty', True, 'env')
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -230,3 +230,9 @@ def setup(app):
|
|||||||
directives.register_directive('describe', ObjectDescription)
|
directives.register_directive('describe', ObjectDescription)
|
||||||
# new, more consistent, name
|
# new, more consistent, name
|
||||||
directives.register_directive('object', ObjectDescription)
|
directives.register_directive('object', ObjectDescription)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -383,3 +383,9 @@ def setup(app):
|
|||||||
directives.register_directive('code-block', CodeBlock)
|
directives.register_directive('code-block', CodeBlock)
|
||||||
directives.register_directive('sourcecode', CodeBlock)
|
directives.register_directive('sourcecode', CodeBlock)
|
||||||
directives.register_directive('literalinclude', LiteralInclude)
|
directives.register_directive('literalinclude', LiteralInclude)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -431,3 +431,9 @@ def setup(app):
|
|||||||
directives.register_directive('cssclass', Class)
|
directives.register_directive('cssclass', Class)
|
||||||
# new standard name when default-domain with "class" is in effect
|
# new standard name when default-domain with "class" is in effect
|
||||||
directives.register_directive('rst-class', Class)
|
directives.register_directive('rst-class', Class)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -58,3 +58,9 @@ class Meta(html.Meta):
|
|||||||
def setup(app):
|
def setup(app):
|
||||||
directives.register_directive('figure', Figure)
|
directives.register_directive('figure', Figure)
|
||||||
directives.register_directive('meta', Meta)
|
directives.register_directive('meta', Meta)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -306,3 +306,9 @@ class CDomain(Domain):
|
|||||||
|
|
||||||
def setup(app):
|
def setup(app):
|
||||||
app.add_domain(CDomain)
|
app.add_domain(CDomain)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -4592,3 +4592,9 @@ def setup(app):
|
|||||||
app.add_config_value("cpp_index_common_prefix", [], 'env')
|
app.add_config_value("cpp_index_common_prefix", [], 'env')
|
||||||
app.add_config_value("cpp_id_attributes", [], 'env')
|
app.add_config_value("cpp_id_attributes", [], 'env')
|
||||||
app.add_config_value("cpp_paren_attributes", [], 'env')
|
app.add_config_value("cpp_paren_attributes", [], 'env')
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -238,3 +238,9 @@ class JavaScriptDomain(Domain):
|
|||||||
|
|
||||||
def setup(app):
|
def setup(app):
|
||||||
app.add_domain(JavaScriptDomain)
|
app.add_domain(JavaScriptDomain)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -800,3 +800,9 @@ class PythonDomain(Domain):
|
|||||||
|
|
||||||
def setup(app):
|
def setup(app):
|
||||||
app.add_domain(PythonDomain)
|
app.add_domain(PythonDomain)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -160,3 +160,9 @@ class ReSTDomain(Domain):
|
|||||||
|
|
||||||
def setup(app):
|
def setup(app):
|
||||||
app.add_domain(ReSTDomain)
|
app.add_domain(ReSTDomain)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -862,3 +862,9 @@ class StandardDomain(Domain):
|
|||||||
|
|
||||||
def setup(app):
|
def setup(app):
|
||||||
app.add_domain(StandardDomain)
|
app.add_domain(StandardDomain)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
@@ -349,3 +349,9 @@ def setup(app):
|
|||||||
|
|
||||||
for rolename, func in iteritems(specific_docroles):
|
for rolename, func in iteritems(specific_docroles):
|
||||||
roles.register_local_role(rolename, func)
|
roles.register_local_role(rolename, func)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'version': 'builtin',
|
||||||
|
'parallel_read_safe': True,
|
||||||
|
'parallel_write_safe': True,
|
||||||
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user