source: trunk/adm/makefile @ 175

Last change on this file since 175 was 158, checked in by pinsard, 12 years ago

an other step of a better usage of sphinx for doc dev

  • Property svn:executable set to *
File size: 4.0 KB
RevLine 
[2]1#+
2#
3# .. _makefile:
4#
5# ========
6# makefile
7# ========
8#
[158]9# surcouche génération des documentations tropflux
[2]10#
[58]11# SEE ALSO
12# ========
13#
14# :ref:`build_doc`
15#
[2]16# TODO
17# ====
18#
19# usage of sphinx/source/Makefile
20#
[158]21# EVOLUTIONS
22# ==========
[2]23#
[158]24# $Id$
[30]25#
[158]26# $URL$
[148]27#
[158]28# - fplod 20120306
29#   
30#   * remove features which are now in makefile_non_sphinx and docs/docs_dev
31#   * remove doxygen stuff
[2]32#
[58]33# - fplod 20110628T140016Z aedon.locean-ipsl.upmc.fr (Darwin)
34#
35#   * correction according to build_doc.rst
[158]36#
[50]37# - fplod 20110421T160731Z aedon.locean-ipsl.upmc.fr (Darwin)
38#
39#   * correction for pdf_user
40#
[42]41# - fplod 20110411T160342Z aedon.locean-ipsl.upmc.fr (Darwin)
42#
43#   * handle paper01/fig*/*.pro (quite ugly !!)
44#
[36]45# - fplod 20110401T091241Z aedon.locean-ipsl.upmc.fr (Darwin)
46#
47#   * replace URLPUBLISH by URLPUBLISH_DEV
48#   * replace DIRWWW by DIRWWW_DEV
[54]49#   * add URLPUBLISH_USER and DIRWWW_USER to handle website
50#
[34]51# - fplod 20110203T101853Z aedon.locean-ipsl.upmc.fr (Darwin)
52#
53#   * add cdo inventory file for sphinx intermapping
54#
[31]55# - fplod 20110110T165518Z aedon.locean-ipsl.upmc.fr (Darwin)
56#
57#   * add odv files
58#
[30]59# - fplod 20110106T135021Z aedon.locean-ipsl.upmc.fr (Darwin)
60#
61#   * add matlab, ferret files
62#
[25]63# - fplod 20101223T083725Z aedon.locean-ipsl.upmc.fr (Darwin)
64#
65#   * add nco inventory file for sphinx intermapping
66#
[20]67# - fplod 20101220T092552Z aedon.locean-ipsl.upmc.fr (Darwin)
[2]68#
[20]69#   * add saxo inventory file for sphinx intermapping
70#
[2]71# - fplod 20101118T165524Z aedon.locean-ipsl.upmc.fr (Darwin)
72#
73#   * creation
74#
75#
76#-
77#
78PRODUCT = \
79tropflux
80
81PRODUCTNAME = \
82$$(echo $(PRODUCT) | tr [:lower:] [:upper:])
83
84SUBPRODUCT = \
85tropflux_ws
86
87DIRSRC = \
88../src/
89
90DIRADM = \
91./
92
93DIRTMP = \
94./
95
[36]96DIRWWW_DEV = \
[2]97../doc/
98
[36]99DIRWWW_USER = \
100./website/_build/
101
102URLPUBLISH_DEV = \
[2]103http://www.locean-ipsl.upmc.fr/~fplod/$(PRODUCT)/$(SUBPRODUCT)/doc/
104
[36]105URLPUBLISH_USER = \
106http://www.locean-ipsl.upmc.fr/~tropflux
107
[2]108.PHONY : \
109help \
110before \
111clean \
112cleantmp \
113design \
114htmllinkcheckb \
115htmllinkchecka \
116spellcheck \
117all \
118html \
[36]119html_dev \
120html_user \
[2]121pdf \
[36]122pdf_dev \
123pdf_dev_sphinx \
[158]124pdf_user
[2]125
126help :
127        @echo "Prepare output directories :"
128        @echo "\$$ make before"
129        @echo ""
130        @echo "Following commands are available to build outputs :"
[58]131        @echo "\$$ make all_dev"
[2]132        @echo " "
133        @echo "Check links before installation : "
134        @echo "\$$ make htmllinkcheckb"
135        @echo " "
136        @echo "Last step = installation of HTML and pdf files"
137        @echo "\$$ make install_all"
138        @echo " "
139        @echo "Check links after installation : "
140        @echo "\$$ make htmllinkchecka"
141        @echo " "
142
143before :
[36]144        @mkdir -p $(DIRWWW_DEV)/man/man1/
[2]145
146install_all : \
[36]147install_html_dev \
148install_html_user \
149install_pdf_dev \
[158]150install_pdf_user
[2]151
[36]152install_html_dev :
153        @$(DIRADM)/install.sh -w $(DIRWWW_DEV)/html/ -u $(URLPUBLISH_DEV)/html/
[2]154
[36]155install_html_user :
156        @$(DIRADM)/install.sh -w $(DIRWWW_USER)/ -u $(URLPUBLISH_USER)/
[2]157
[36]158install_pdf_dev :
159        @$(DIRADM)/install.sh -w $(DIRWWW_DEV)/pdf/ -u $(URLPUBLISH_DEV)/pdf/
160
161install_pdf_user :
162        @$(DIRADM)/install.sh -w $(DIRWWW_USER)/pdf/ -u $(URLPUBLISH_USER)/pdf/
163
[2]164clean : \
165cleantmp
[36]166        -@rm -fr $(DIRWWW_DEV)/man/
167        -@rm -fr $(DIRWWW_DEV)/html/
168        -@rm -fr $(DIRWWW_DEV)/pdf/
[158]169        cd ../docs/docs_dev/; make clean
[36]170        cd $(DIRADM)/website/; make clean
[2]171
172
173cleantmp :
174        -@rm -f $(DIRTMP)/sphinx_*.log
175
176htmllinkcheckb :
[36]177        @$(DIRADM)/linkchecker.sh -d $(DIRWWW_DEV)/html/
178        @$(DIRADM)/linkchecker.sh -d $(DIRWWW_USER)
[2]179
180htmllinkchecka :
[36]181        @$(DIRADM)/linkchecker.sh -u $(URLPUBLISH_DEV)
182        @$(DIRADM)/linkchecker.sh -u $(URLPUBLISH_USER)
[2]183
184spellcheck :
185        @++aspell --mode=sgml --master=english -c \
186        $(DIRSRC)/$(PRODUCT).xml
187
188all : \
[58]189all_dev \
190all_user
191
192all_dev : \
193html_dev \
194pdf_dev \
[158]195man_dev
[2]196
[58]197all_user : \
198html_user \
199pdf_user
200
[2]201html : \
[36]202html_user \
203html_dev
[2]204
[54]205html_user :
[36]206        cd $(DIRADM)/website/; make html
207
208html_dev : \
209html_dev_sphinx \
210html_dev_sphinx_one
211
[158]212html_dev_sphinx :
213        cd ../docs/docs_dev; make html
[2]214
[158]215html_dev_sphinx_one :
216        cd ../docs/docs_dev; make singlehtml
[2]217
218pdf : \
[36]219pdf_user \
220pdf_dev
[2]221
[36]222pdf_user :
[54]223        cd $(DIRADM)/website/; make latexpdf
[36]224
[158]225pdf_dev :
226        cd ../docs/docs_dev; make latexpdf
[36]227
[158]228man_dev :
229        cd ../docs/docs_dev; make man
Note: See TracBrowser for help on using the repository browser.