xref: /aosp_15_r20/external/pytorch/docs/Makefile (revision da0073e96a02ea20f0ac840b70461e3646d07c45)
1*da0073e9SAndroid Build Coastguard Worker# Minimal makefile for Sphinx documentation
2*da0073e9SAndroid Build Coastguard Worker#
3*da0073e9SAndroid Build Coastguard Worker
4*da0073e9SAndroid Build Coastguard Worker# You can set these variables from the command line.
5*da0073e9SAndroid Build Coastguard WorkerSPHINXOPTS    ?= -j auto -WT --keep-going
6*da0073e9SAndroid Build Coastguard WorkerSPHINXBUILD   ?= sphinx-build
7*da0073e9SAndroid Build Coastguard WorkerSPHINXPROJ    ?= PyTorch
8*da0073e9SAndroid Build Coastguard WorkerSOURCEDIR     ?= source
9*da0073e9SAndroid Build Coastguard WorkerBUILDDIR      ?= build
10*da0073e9SAndroid Build Coastguard WorkerPYCMD         ?= python
11*da0073e9SAndroid Build Coastguard Worker
12*da0073e9SAndroid Build Coastguard Worker# Put it first so that "make" without argument is like "make help".
13*da0073e9SAndroid Build Coastguard Workerhelp:
14*da0073e9SAndroid Build Coastguard Worker	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
15*da0073e9SAndroid Build Coastguard Worker
16*da0073e9SAndroid Build Coastguard Workerfigures:
17*da0073e9SAndroid Build Coastguard Worker	@$(PYCMD) source/scripts/build_activation_images.py
18*da0073e9SAndroid Build Coastguard Worker	@$(PYCMD) source/scripts/build_quantization_configs.py
19*da0073e9SAndroid Build Coastguard Worker
20*da0073e9SAndroid Build Coastguard Workeronnx:
21*da0073e9SAndroid Build Coastguard Worker	@$(PYCMD) source/scripts/onnx/build_onnx_torchscript_supported_aten_op_csv_table.py
22*da0073e9SAndroid Build Coastguard Worker	@$(PYCMD) source/scripts/onnx/build_onnx_dynamo_diagnostics_rules_md.py $(SOURCEDIR)/generated/onnx_dynamo_diagnostics_rules
23*da0073e9SAndroid Build Coastguard Worker
24*da0073e9SAndroid Build Coastguard Workeropset:
25*da0073e9SAndroid Build Coastguard Worker	@$(PYCMD) source/scripts/build_opsets.py
26*da0073e9SAndroid Build Coastguard Worker
27*da0073e9SAndroid Build Coastguard Workerexportdb:
28*da0073e9SAndroid Build Coastguard Worker	@$(PYCMD) source/scripts/exportdb/generate_example_rst.py
29*da0073e9SAndroid Build Coastguard Worker
30*da0073e9SAndroid Build Coastguard Workerdocset: html
31*da0073e9SAndroid Build Coastguard Worker	doc2dash --name $(SPHINXPROJ) --icon $(SOURCEDIR)/_static/img/pytorch-logo-flame.png --enable-js --online-redirect-url https://pytorch.org/docs/ --force $(BUILDDIR)/html/
32*da0073e9SAndroid Build Coastguard Worker
33*da0073e9SAndroid Build Coastguard Worker	# Manually fix because Zeal doesn't deal well with `icon.png`-only at 2x resolution.
34*da0073e9SAndroid Build Coastguard Worker	cp $(SPHINXPROJ).docset/icon.png $(SPHINXPROJ).docset/icon@2x.png
35*da0073e9SAndroid Build Coastguard Worker	convert $(SPHINXPROJ).docset/icon@2x.png -resize 16x16 $(SPHINXPROJ).docset/icon.png
36*da0073e9SAndroid Build Coastguard Worker
37*da0073e9SAndroid Build Coastguard Workerhtml-stable:
38*da0073e9SAndroid Build Coastguard Worker	# stable differs from `make html` in two ways:
39*da0073e9SAndroid Build Coastguard Worker	# 1) The stable logo is used instead of the unstable logo
40*da0073e9SAndroid Build Coastguard Worker	# 2) There will not be a link to the stable docs.
41*da0073e9SAndroid Build Coastguard Worker	# See conf.py for more details.
42*da0073e9SAndroid Build Coastguard Worker	RELEASE=1 make html
43*da0073e9SAndroid Build Coastguard Worker
44*da0073e9SAndroid Build Coastguard Worker.PHONY: help Makefile docset onnx exportdb
45*da0073e9SAndroid Build Coastguard Worker
46*da0073e9SAndroid Build Coastguard Worker# Catch-all target: route all unknown targets to Sphinx using the new
47*da0073e9SAndroid Build Coastguard Worker# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
48*da0073e9SAndroid Build Coastguard Worker%: Makefile figures onnx opset exportdb
49*da0073e9SAndroid Build Coastguard Worker	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
50*da0073e9SAndroid Build Coastguard Worker
51*da0073e9SAndroid Build Coastguard Workerclean:
52*da0073e9SAndroid Build Coastguard Worker	@echo "Removing everything under 'build' and 'source/generated'.."
53*da0073e9SAndroid Build Coastguard Worker	@rm -rf $(BUILDDIR)/html/ $(BUILDDIR)/doctrees $(SOURCEDIR)/generated $(BUILDDIR)/auto_gen_aten_op_list.csv
54