doc/book/fr/makefile
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Tue, 22 Sep 2009 18:59:00 +0200
branchstable
changeset 3372 26b89dfe4170
parent 625 e57cc039b418
permissions -rw-r--r--
typo
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
53
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
     1
MKHTML=mkdoc
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
     2
MKHTMLOPTS=--doctype article --target html --stylesheet standard 
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
     3
SRC=.
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
     4
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
     5
TXTFILES:= $(wildcard *.txt)
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
     6
TARGET := $(TXTFILES:.txt=.html)
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
     7
53
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
     8
# You can set these sphinx variables from the command line.
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
     9
SPHINXOPTS    =
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    10
SPHINXBUILD   = sphinx-build
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    11
PAPER         =
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    12
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    13
# Internal variables for sphinx
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    14
PAPEROPT_a4     = -D latex_paper_size=a4
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    15
PAPEROPT_letter = -D latex_paper_size=letter
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    16
ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    17
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    18
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    19
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    20
53
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    21
help:
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    22
	@echo "Please use \`make <target>' where <target> is one of"
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    23
	@echo "  all       to make standalone HTML files, developer manual and API doc"
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    24
	@echo "  apidoc    to make API doc"
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    25
	@echo "  html      to make standalone HTML files"
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    26
	@echo "---  "	
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    27
	@echo "  pickle    to make pickle files (usable by e.g. sphinx-web)"
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    28
	@echo "  htmlhelp  to make HTML files and a HTML help project"
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    29
	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    30
	@echo "  changes   to make an overview over all changed/added/deprecated items"
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    31
	@echo "  linkcheck to check all external links for integrity"
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    32
53
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    33
clean:
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    34
	rm -rf apidoc/
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    35
	rm -f *.html
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    36
	-rm -rf build/*
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    37
56
3a8576dd00d8 [doc] move .static and .templates
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 53
diff changeset
    38
all: ${TARGET} apidoc html
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    39
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    40
%.html: %.txt
53
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    41
	${MKHTML} ${MKHTMLOPTS} $<
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    42
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    43
#apydoc: 
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    44
#	epydoc --html -o epydoc/ -n ../server/*.py ../core/*.py ../common/*.py ../server/*/*.py ../modpython/*/*.py ../common/*/*.py
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    45
apidoc:
625
e57cc039b418 [doc] fix path in makefile
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 56
diff changeset
    46
	epydoc --html -o apidoc -n "cubicweb" --exclude=setup --exclude=__pkginfo__ ../../../
53
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    47
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    48
# run sphinx ###
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    49
html:
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    50
	mkdir -p build/html build/doctrees
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    51
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    52
	@echo
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    53
	@echo "Build finished. The HTML pages are in build/html."
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    54
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    55
pickle:
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    56
	mkdir -p build/pickle build/doctrees
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    57
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    58
	@echo
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    59
	@echo "Build finished; now you can process the pickle files or run"
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    60
	@echo "  sphinx-web build/pickle"
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    61
	@echo "to start the sphinx-web server."
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    62
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    63
web: pickle
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    64
53
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    65
htmlhelp:
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    66
	mkdir -p build/htmlhelp build/doctrees
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    67
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    68
	@echo
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    69
	@echo "Build finished; now you can run HTML Help Workshop with the" \
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    70
	      ".hhp project file in build/htmlhelp."
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    71
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    72
latex:
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    73
	mkdir -p build/latex build/doctrees
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    74
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    75
	@echo
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    76
	@echo "Build finished; the LaTeX files are in build/latex."
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    77
	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    78
	      "run these through (pdf)latex."
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    79
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    80
changes:
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    81
	mkdir -p build/changes build/doctrees
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    82
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    83
	@echo
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    84
	@echo "The overview file is in build/changes."
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    85
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    86
linkcheck:
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    87
	mkdir -p build/linkcheck build/doctrees
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    88
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    89
	@echo
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    90
	@echo "Link check complete; look for any errors in the above output " \
537ad3e8e461 [doc] moved makefile. corrected paths to images.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 50
diff changeset
    91
	      "or in build/linkcheck/output.txt."