Skip to content

Speedup sphinx-build using parallelization #991

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
merged 7 commits into from
Mar 9, 2021
Merged

Speedup sphinx-build using parallelization #991

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1a4c874
Parallel sphinx-build to speed up documentation build
weiji14 Mar 2, 2021
c510583
Fix a typo in test_grdinfo
weiji14 Mar 3, 2021
89f1f94
Remove linkcheck and doctest targets in doc/Makefile
weiji14 Mar 3, 2021
f04173b
Remove help docs for linkcheck and doctest targets for doc/Makefile
weiji14 Mar 3, 2021
d894f1a
Merge branch 'master' into parallel-sphinx-build
weiji14 Mar 3, 2021
73c80b0
Merge branch 'master' into parallel-sphinx-build
weiji14 Mar 8, 2021
f5d93b6
Move `-j auto` to SPHINXOPTS
weiji14 Mar 9, 2021
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
6 changes: 3 additions & 3 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ html: api
@echo
@echo "Building HTML files."
@echo
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
$(SPHINXBUILD) -b html -j auto $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

Expand All @@ -47,13 +47,13 @@ api:


linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
$(SPHINXBUILD) -b linkcheck -j auto $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
$(SPHINXBUILD) -b doctest -j auto $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

Expand Down