openstack
/
oslo.config
Code Issues Proposed changes

Mark sphinx extensions thread safe 

This adds the return of some metadata to our sphinx extension setup to
indicate they are thread safe. This is needed to allow consuming
projects to do multithreaded docs builds. In some cases, this can save a
noticeable amount of time in job execution.

Change-Id: I53a580b336a49372e27b69d009da555c03f03e35
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This commit is contained in:
Sean McGinnis 2020-04-13 08:56:15 -05:00 committed by Stephen Finucane
parent 1b248b4f98
commit 76075a6d99
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
oslo_config/sphinxconfiggen.py
View File

@ -91,3 +91,7 @@ def setup(app):
app.add_config_value('config_generator_config_file', None, 'env')
app.add_config_value('sample_config_basename', None, 'env')
app.connect('builder-inited', generate_sample)
return {
'parallel_read_safe': True,
'parallel_write_safe': True,
}

4
oslo_config/sphinxext.py
View File

@ -508,3 +508,7 @@ def setup(app):
oslo_i18n.enable_lazy(False)
app.add_directive('show-options', ShowOptionsDirective)
app.add_domain(ConfigDomain)
return {
'parallel_read_safe': True,
'parallel_write_safe': True,
}