mirror of
https://github.com/saymrwulf/pytorch.git
synced 2026-05-14 20:57:59 +00:00
1dc708493e
Summary: This lets one build docs for the release easier. All of the unstable warnings are removed in `make html-stable`. cc soumith SsnL Sample build:  Pull Request resolved: https://github.com/pytorch/pytorch/pull/9884 Reviewed By: SsnL Differential Revision: D9016001 Pulled By: zou3519 fbshipit-source-id: 5cf2dfbf886de993242db28cdac5d0c5fadbdc4d
42 lines
1.4 KiB
Makefile
42 lines
1.4 KiB
Makefile
# Minimal makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line.
|
|
SPHINXOPTS =
|
|
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 http://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 -r $(BUILDDIR)/html/ $(BUILDDIR)/doctrees
|