summaryrefslogtreecommitdiff
path: root/docs/source/Makefile
blob: 78a84889fc9751d3b2cd87a20ea51e132db77c51 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS    =
SPHINXBUILD   = sphinx-build
VERSION      ?= tip

# Internal variables.
ALLSPHINXOPTS   = -d ../doctrees $(SPHINXOPTS) .

help:
	@echo "Please use \`make <target>' where <target> is one of"
	@echo "  html      to make standalone HTML files"
	@echo "  text      to make standalone text files"
	@echo "  sdist     to build documentation for release"
	@echo "  doctest   to run doctests"
	@echo "  pickles   to build pickles"
	@echo "  clean     to remove generated artifacts"

sdist: clean text html

clean:
	for i in doctrees html text doctest pickles website; do \
	    rm -rf ../$$i; \
        done

html:
	mkdir -p ../html ../doctrees _static _template
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ../html
	@echo
	@echo "Build finished. The HTML pages are in ../html."

text:
	mkdir -p ../text ../doctrees
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) ../text
	@echo
	@echo "Build finished. The text pages are in ../text."

doctest:
	mkdir -p ../doctrees ../doctest
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) ../doctest

pickles:
	mkdir -p ../pickles ../doctest
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) ../pickles

website:
	mkdir -p ../website ../doctrees
	$(SPHINXBUILD) -b discorporate \
           -D html_theme=discorporate \
           -D version=$(VERSION) \
           $(ALLSPHINXOPTS) ../website