source: main/branches/1.1/docs/Makefile @ 1193

Revision 1193, 2.6 KB checked in by alefebvre, 8 years ago (diff)

[doc] Modification of the docs folder layout to ease management of multiple
translations

Creation of an 'en' folder to store english documentation
Creation of a 'skel' folder, template for futur translations folders
Creation of a global documentation Makefile

Line 
1# Makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS    =
6SPHINXBUILD   = sphinx-build
7PAPER         =
8BUILDDIR      = _build
9
10# Internal variables.
11PAPEROPT_a4     = -D latex_paper_size=a4
12PAPEROPT_letter = -D latex_paper_size=letter
13ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14
15.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
16
17CHDIR_SHELL := $(SHELL)
18define chdir
19   $(eval _D=$(firstword $(1) $(@D)))
20   $(info $(MAKE): cd $(_D)) $(eval SHELL = cd $(_D); $(CHDIR_SHELL))
21endef
22
23ifndef $(LANGUAGE)
24    LANGUAGE = en
25endif
26
27help:
28        @echo "Please use \`make <target>' where <target> is one of"
29        @echo "  html       to make standalone HTML files"
30        @echo "  dirhtml    to make HTML files named index.html in directories"
31        @echo "  singlehtml to make a single large HTML file"
32        @echo "  pickle     to make pickle files"
33        @echo "  json       to make JSON files"
34        @echo "  htmlhelp   to make HTML files and a HTML help project"
35        @echo "  qthelp     to make HTML files and a qthelp project"
36        @echo "  devhelp    to make HTML files and a Devhelp project"
37        @echo "  epub       to make an epub"
38        @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
39        @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
40        @echo "  text       to make text files"
41        @echo "  man        to make manual pages"
42        @echo "  changes    to make an overview of all changed/added/deprecated items"
43        @echo "  linkcheck  to check all external links for integrity"
44        @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
45        @echo "To specify a language different than English use somethink like :"
46        @echo "make LANGUAGE=fr html"
47
48clean:
49        cd $(LANGUAGE) && make clean
50
51tuto:
52        cd $(LANGUAGE) && make tuto
53
54oxt:
55        cd $(LANGUAGE) && make oxt
56
57dl: tuto oxt
58
59html: dl
60        cd $(LANGUAGE) && make html
61
62dirhtml: dl
63        cd $(LANGUAGE) && make dirhtml
64
65singlehtml: dl
66        cd $(LANGUAGE) && make singlehtml
67
68pickle: dl
69        cd $(LANGUAGE) && make pickle
70
71json: dl
72        cd $(LANGUAGE) && make json
73
74htmlhelp: dl
75        cd $(LANGUAGE) && make htmlhelp
76
77qthelp: dl
78        cd $(LANGUAGE) && make qthelp
79
80devhelp: dl
81        cd $(LANGUAGE) && make devhelp
82
83epub: dl
84        cd $(LANGUAGE) && make epub
85
86latex: dl
87        cd $(LANGUAGE) && make latex
88
89latexpdf:
90        cd $(LANGUAGE) && make latexpdf
91
92text: dl
93        cd $(LANGUAGE) && make text
94
95man: dl
96        cd $(LANGUAGE) && make man
97
98changes:
99        cd $(LANGUAGE) && make changes
100
101linkcheck:
102        cd $(LANGUAGE) && make linkcheck
103
104doctest:
105        cd $(LANGUAGE) && make doctest
Note: See TracBrowser for help on using the repository browser.