mirror of
https://github.com/pytorch/pytorch.git
synced 2025-10-20 12:54:11 +08:00
481838f21b
Summary: See https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-j > Distribute the build over N processes in parallel, to make building on multiprocessor machines more effective. Note that not all parts and not all builders of Sphinx can be parallelized. If auto argument is given, Sphinx uses the number of CPUs as N. - Timing results - Python doc build on a 40-core machine: 9:34 down to 1:29 - pytorch_cpp_doc_push: ~1h 10m down to 47m - pytorch_python_doc_push: 34m down to 32m Pull Request resolved: https://github.com/pytorch/pytorch/pull/38785 Differential Revision: D21691991 Pulled By: zou3519 fbshipit-source-id: cfc5e8cd13414640f82edfd2ad1ce4d9c7afce12
43 lines
1.4 KiB
Makefile
43 lines
1.4 KiB
Makefile
# Minimal makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line.
|
|
SPHINXOPTS = -j auto
|
|
SPHINXBUILD = sphinx-build
|
|
SPHINXPROJ = PyTorch
|
|
SOURCEDIR = source
|
|
BUILDDIR = build
|
|
PYCMD = python
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
help:
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
figures:
|
|
@$(PYCMD) source/scripts/build_activation_images.py
|
|
|
|
docset: html
|
|
doc2dash --name $(SPHINXPROJ) --icon $(SOURCEDIR)/_static/img/pytorch-logo-flame.png --enable-js --online-redirect-url https://pytorch.org/docs/ --force $(BUILDDIR)/html/
|
|
|
|
# Manually fix because Zeal doesn't deal well with `icon.png`-only at 2x resolution.
|
|
cp $(SPHINXPROJ).docset/icon.png $(SPHINXPROJ).docset/icon@2x.png
|
|
convert $(SPHINXPROJ).docset/icon@2x.png -resize 16x16 $(SPHINXPROJ).docset/icon.png
|
|
|
|
html-stable:
|
|
# stable differs from `make html` in two ways:
|
|
# 1) The stable logo is used instead of the unstable logo
|
|
# 2) There will not be a link to the stable docs.
|
|
# See conf.py for more details.
|
|
RELEASE=1 make html
|
|
|
|
.PHONY: help Makefile docset
|
|
|
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
%: Makefile figures
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
clean:
|
|
@echo "Removing everything under 'build'.."
|
|
@rm -rf $(BUILDDIR)/html/ $(BUILDDIR)/doctrees
|