From 76075a6d992c08a29da76c34fb2a7d9164f721d0 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Mon, 13 Apr 2020 08:56:15 -0500 Subject: [PATCH] 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 --- oslo_config/sphinxconfiggen.py | 4 ++++ oslo_config/sphinxext.py | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/oslo_config/sphinxconfiggen.py b/oslo_config/sphinxconfiggen.py index ff7172cb..616e8573 100644 --- a/oslo_config/sphinxconfiggen.py +++ b/oslo_config/sphinxconfiggen.py @@ -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, + } diff --git a/oslo_config/sphinxext.py b/oslo_config/sphinxext.py index 905490c7..4a111633 100644 --- a/oslo_config/sphinxext.py +++ b/oslo_config/sphinxext.py @@ -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, + }