From e68d33ef683db1f729a7c2102e4a04a67c5565bb Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Tue, 14 Jul 2020 13:36:31 -0500 Subject: [PATCH] Make docs build parallel This updates our thread extension and tox command for docs builds to use the available number of cores to multithread the docs build. This can speed things up significantly. Depends-on: https://review.opendev.org/741026 Change-Id: I1ba656390094b4e1c6d3fb7bb3028eadb11c4d08 Signed-off-by: Sean McGinnis --- doc/ext/cinder_driverlist.py | 4 ++++ doc/ext/driver_opts.py | 4 ++++ doc/requirements.txt | 2 +- tox.ini | 2 +- 4 files changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/ext/cinder_driverlist.py b/doc/ext/cinder_driverlist.py index 9182f0ee9a0..2a49b26a5da 100644 --- a/doc/ext/cinder_driverlist.py +++ b/doc/ext/cinder_driverlist.py @@ -22,4 +22,8 @@ def setup(app): print('** Generating driver list...') rv = utils.execute(sys.executable, './tools/generate_driver_list.py', ['docs']) print(rv[0]) + return { + 'parallel_read_safe': True, + 'parallel_write_safe': True, + } diff --git a/doc/ext/driver_opts.py b/doc/ext/driver_opts.py index 27bcee4d2c5..37e19622fbd 100644 --- a/doc/ext/driver_opts.py +++ b/doc/ext/driver_opts.py @@ -142,3 +142,7 @@ class ConfigTableDirective(rst.Directive): def setup(app): app.add_directive('config-table', ConfigTableDirective) + return { + 'parallel_read_safe': True, + 'parallel_write_safe': True, + } diff --git a/doc/requirements.txt b/doc/requirements.txt index a7d9c2ea3bb..171e1885d53 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -6,4 +6,4 @@ reno>=3.1.0 # Apache-2.0 sphinx>=2.0.0,!=2.1.0 # BSD os-api-ref>=1.5.0 # Apache-2.0 sphinxcontrib-apidoc>=0.2.0 # BSD -sphinx-feature-classification>=0.1.0 # Apache 2.0 +sphinx-feature-classification>=1.1.0 # Apache 2.0 diff --git a/tox.ini b/tox.ini index 82efa720005..655ace4e033 100644 --- a/tox.ini +++ b/tox.ini @@ -131,7 +131,7 @@ deps = commands = rm -fr doc/source/contributor/api/ rm -fr doc/build/html doc/build/doctrees - sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html + sphinx-build -W -j auto -b html -d doc/build/doctrees doc/source doc/build/html whitelist_externals = rm [testenv:pdf-docs]