| # Minimal makefile for Sphinx documentation | |
| # | |
| # You can set these variables from the command line. | |
| SPHINXOPTS ?= -j auto -WT --keep-going | |
| 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 | |
| @$(PYCMD) source/scripts/build_quantization_configs.py | |
| onnx: | |
| @$(PYCMD) source/scripts/onnx/build_onnx_supported_aten_op_csv_table.py | |
| @$(PYCMD) source/scripts/onnx/build_onnx_diagnostics_rules_md.py $(SOURCEDIR)/generated/onnx_diagnostics_rules | |
| opset: | |
| @$(PYCMD) source/scripts/build_opsets.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 onnx | |
| # 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 onnx opset | |
| @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | |
| clean: | |
| @echo "Removing everything under 'build' and 'source/generated'.." | |
| @rm -rf $(BUILDDIR)/html/ $(BUILDDIR)/doctrees $(SOURCEDIR)/generated $(BUILDDIR)/auto_gen_aten_op_list.csv |