Makefile 1.63 KB
Newer Older
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
1
2
3
# Minimal makefile for Sphinx documentation
#

4
5
6
7
ifneq ($(EXAMPLES_PATTERN),)
    EXAMPLES_PATTERN_OPTS := -D sphinx_gallery_conf.filename_pattern="$(EXAMPLES_PATTERN)"
endif

Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
8
# You can set these variables from the command line.
9
SPHINXOPTS    = -W -j auto $(EXAMPLES_PATTERN_OPTS)
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
SPHINXBUILD   = sphinx-build
SPHINXPROJ    = torchvision
SOURCEDIR     = source
BUILDDIR      = build

# Put it first so that "make" without argument is like "make help".
help:
	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docset: html
	doc2dash --name $(SPHINXPROJ) --icon $(SOURCEDIR)/_static/img/pytorch-logo-flame.png --enable-js --online-redirect-url http://pytorch.org/vision/ --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

26
html-noplot:  # Avoids running the gallery examples, which may take time
27
	$(SPHINXBUILD) -D plot_gallery=0 -b html "${SOURCEDIR}" "$(BUILDDIR)"/html
28
29
30
31
32
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

clean:
	rm -rf $(BUILDDIR)/*
33
34
	rm -rf $(SOURCEDIR)/auto_examples/  # sphinx-gallery
	rm -rf $(SOURCEDIR)/gen_modules/  # sphinx-gallery
35
	rm -rf $(SOURCEDIR)/generated/  # autosummary
36
	rm -rf $(SOURCEDIR)/models/generated  # autosummary
37

Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
38
39
40
41
42
43
.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
	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)