Skip to content

DOC: Enable parallel builds #28617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timhoffm merged 1 commit into from
Jul 28, 2024
Merged

DOC: Enable parallel builds #28617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ commands:
export RELEASE_TAG='-t release'
fi
mkdir -p logs
make html O="-T $RELEASE_TAG -j1 -w /tmp/sphinxerrorswarnings.log"
make html O="-T $RELEASE_TAG -j4 -w /tmp/sphinxerrorswarnings.log"
rm -r build/html/_sources
working_directory: doc
- save_cache:
Expand Down
5 changes: 5 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,11 @@ def tutorials_download_error(record):
'copyfile_regex': r'.*\.rst',
}

if parse_version(sphinx_gallery.__version__) >= parse_version('0.17.0'):
sphinx_gallery_conf['parallel'] = True
# Any warnings from joblib turned into errors may cause a deadlock.
warnings.filterwarnings('default', category=UserWarning, module='joblib')

if 'plot_gallery=0' in sys.argv:
# Gallery images are not created. Suppress warnings triggered where other
# parts of the documentation link to these images.
Expand Down
2 changes: 1 addition & 1 deletion requirements/doc/doc-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ pyyaml
sphinxcontrib-svg2pdfconverter>=1.1.0
sphinx-copybutton
sphinx-design
sphinx-gallery>=0.12.0
sphinx-gallery[parallel]>=0.12.0
sphinx-tags>=0.4.0