blob: 021db78579f1338cc8e57f685d46230f1d1f372f (
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
SRCDIR = ..
ROOTDIR = $(dir $(lastword $(MAKEFILE_LIST)))
COMMAND_NAME ?= $(shell basename $$(dirname `pwd`))
# command names that shall be installed together with this one
# in order to generated documentation
REQUIRED_COMMANDS ?=
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: \
help clean html dirhtml singlehtml epub latex latexpdf cmdline.generated
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " "
@echo " cmdregen to regenerate cmdline.generated with actual content from installed lmi help"
cmdregen: cmdline.generated
cmdline.generated:
if ! python -c 'import lmi.scripts.$(COMMAND_NAME)' >/dev/null; then \
echo "Please install install the command library first." >&2; \
exit 1; \
fi
( \
echo ".."; \
echo " !!!!!!!!!"; \
echo -n " This is generated file. Use 'make cmdregen' to regenerate it"; \
echo " from installed 'lmi help <CMD_NAME>'"; \
echo " !!!!!!!!!"; \
echo ; \
for i in `sed -n '/entry_points/,/)/p' $(SRCDIR)/setup.py | \
sed -n "s/\s*,\?['\"]\s*\([a-z-]\+\)\s*=.*/\1/p"`; do \
lmi help $$i | python $(ROOTDIR)/tools/help2rst $$i | \
tr -d '\033' |sed 's/..1034h//'; \
done \
) > $@
conf.py: conf.py.skel
make -C $(SRCDIR) setup
%.build: conf.py
SPHINXBUILD=$(SPHINXBUILD) SRCDIR=$(SRCDIR) \
REQUIRED_COMMANDS=$(REQUIRED_COMMANDS) \
$(ROOTDIR)/tools/build-with-sphinx.sh -b $* \
$(ALLSPHINXOPTS) $(BUILDDIR)/$*
@echo "$* build finished. Output is in $(BUILDDIR)/$*."
clean:
-rm -rf $(BUILDDIR)/*
html dirhtml singlehtml epub latex: %: %.build
latexpdf: latex
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
