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
54
55
56
57
58
59
|
# Makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXAUTOGEN = sphinx-autogen
BUILDDIR = _build
# Internal variables.
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) .
.PHONY: help clean html linkcheck doctest api
all: html
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " all generate the complete webpage"
@echo " html make only the HTML files from the existing rst sources"
@echo " linkcheck check all external links for integrity"
@echo " doctest run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/html/*
rm -rf $(BUILDDIR)/doctrees
rm -rf $(BUILDDIR)/linkcheck
rm -rf api/generated
rm -rf gallery
rm -rf tutorials
rm -rf sample_data
rm -rf .ipynb_checkpoints
api:
@echo
@echo "Building API docs."
@echo
$(SPHINXAUTOGEN) -i -t _templates -o api/generated api/index.rst
html: api
@echo
@echo "Building HTML files."
@echo
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
linkcheck: api
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
serve:
cd $(BUILDDIR)/html && python -m http.server 8001
|
