mirror of
https://github.com/pytorch/pytorch.git
synced 2025-10-20 21:14:14 +08:00
f3d16ec76f
Convenience, when we build pytorch docs 1. Docs for build weren't clear that `make html` is the main command intended to be ran 2. Once you run `make html` you need to visualize the work, opening up a simple http server seems like the simplest solution so adding a `make serve command` Usage ```shell numpy ❯ make serve PORT=8080 # Add port optionally Serving HTTP on :: port 8080 (http://[::]:8080/) ... ::1 - - [26/Nov/2024 10:05:41] "GET / HTTP/1.1" 200 - ::1 - - [26/Nov/2024 10:05:41] "GET /_static/copybutton.css HTTP/1.1" 200 - ::1 - - [26/Nov/2024 10:05:41] "GET /_static/katex-math.css HTTP/1.1" 200 - ```  Pull Request resolved: https://github.com/pytorch/pytorch/pull/141590 Approved by: https://github.com/svekars, https://github.com/malfet
57 lines
2.0 KiB
Makefile
57 lines
2.0 KiB
Makefile
# 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_torchscript_supported_aten_op_csv_table.py
|
|
@$(PYCMD) source/scripts/onnx/build_onnx_dynamo_diagnostics_rules_md.py $(SOURCEDIR)/generated/onnx_dynamo_diagnostics_rules
|
|
|
|
opset:
|
|
@$(PYCMD) source/scripts/build_opsets.py
|
|
|
|
exportdb:
|
|
@$(PYCMD) source/scripts/exportdb/generate_example_rst.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 exportdb serve
|
|
|
|
serve:
|
|
@cd $(BUILDDIR)/html && $(PYCMD) -m http.server $(PORT)
|
|
|
|
# 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 exportdb
|
|
@$(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
|