Changeset 158
- Timestamp:
- 03/06/12 18:04:10 (12 years ago)
- Location:
- trunk
- Files:
-
- 6 deleted
- 3 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/adm/makefile
r148 r158 7 7 # ======== 8 8 # 9 # génération des documentations tropflux9 # surcouche génération des documentations tropflux 10 10 # 11 11 # SEE ALSO … … 17 17 # ==== 18 18 # 19 # add -W to sphinx command when encoding problems are solved20 #21 19 # usage of sphinx/source/Makefile 22 #23 # IDL and matlab in man_troff24 #25 # pb with automodule for python path26 #27 # add an target for publishing data and README.rst28 20 # 29 21 # EVOLUTIONS 30 22 # ========== 31 23 # 24 # $Id$ 25 # 26 # $URL$ 27 # 28 # - fplod 20120306 29 # 30 # * remove features which are now in makefile_non_sphinx and docs/docs_dev 31 # * remove doxygen stuff 32 # 32 33 # - fplod 20110628T140016Z aedon.locean-ipsl.upmc.fr (Darwin) 33 34 # 34 35 # * correction according to build_doc.rst 36 # 35 37 # - fplod 20110421T160731Z aedon.locean-ipsl.upmc.fr (Darwin) 36 38 # … … 71 73 # * creation 72 74 # 73 # SEE ALSO74 # ========75 #76 # :ref:`extract_rst.sh`77 75 # 78 76 #- … … 96 94 ./ 97 95 98 DIRDESIGN = \99 ./design/100 101 96 DIRWWW_DEV = \ 102 97 ../doc/ … … 110 105 URLPUBLISH_USER = \ 111 106 http://www.locean-ipsl.upmc.fr/~tropflux 112 113 LIST_INVENTORY = \114 $(DIRADM)/saxo.inv \115 $(DIRADM)/nco.inv \116 $(DIRADM)/cdo.inv117 118 LIST_RST_GUIDES = \119 $(shell find $(DIRADM)/guides/ -name "*.rst" | \120 sed -e "s+$(DIRADM)/guides/+$(DIRTMP)/sphinx_tmpdir/guides/+g")121 122 LIST_SRCSH = \123 $(shell find $(DIRSRC) -name "*.sh" | sort)124 125 LIST_SRCSH_RST = \126 $(shell echo "$(LIST_SRCSH)" | \127 sed -e "s+$(DIRSRC)+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \128 -e "s+\.sh+.sh.rst+g")129 130 LIST_SRCSH_TROFF = \131 $(shell echo "$(LIST_SRCSH)" | \132 sed -e "s+$(DIRSRC)+$(DIRWWW_DEV)/man/man1/+g" \133 -e "s+\.sh+.sh.1+g")134 135 LIST_SRCIDL = \136 $(shell find $(DIRSRC) -name "*.pro" | sort)137 138 LIST_SRCIDL_RST = \139 $(shell echo "$(LIST_SRCIDL)" | \140 sed -e "s+$(DIRSRC)+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \141 -e "s+$(DIRSRC)/paper01/fig1+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig1+g" \142 -e "s+$(DIRSRC)/paper01/fig2+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig2+g" \143 -e "s+$(DIRSRC)/paper01/fig3+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig3+g" \144 -e "s+$(DIRSRC)/paper01/fig4+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig4+g" \145 -e "s+$(DIRSRC)/paper01/fig5+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig5+g" \146 -e "s+$(DIRSRC)/paper01/fig6+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig6+g" \147 -e "s+$(DIRSRC)/paper01/fig7+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig7+g" \148 -e "s+$(DIRSRC)/paper01/fig8+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig8+g" \149 -e "s+$(DIRSRC)/paper01/fig9+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig9+g" \150 -e "s+$(DIRSRC)/paper01/fig10+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig10+g" \151 -e "s+$(DIRSRC)/paper01/fig11+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig11+g" \152 -e "s+$(DIRSRC)/paper01/fig12+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig12+g" \153 -e "s+$(DIRSRC)/paper01/fig13+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig13+g" \154 -e "s+$(DIRSRC)/paper01/fig14+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig14+g" \155 -e "s+$(DIRSRC)/paper01/fig15+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig15+g" \156 -e "s+$(DIRSRC)/paper01/fig16+$(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig16+g" \157 -e "s+\.pro+.pro.rst+g")158 159 LIST_SRCMATLAB = \160 $(DIRSRC)/test/project_startup.m \161 $(DIRSRC)/test/read.m162 163 LIST_SRCMATLAB_RST = \164 $(shell echo "$(LIST_SRCMATLAB)" | \165 sed -e "s+$(DIRSRC)/test/+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \166 -e "s+\.m+.m.rst+g")167 168 LIST_SRCFERRET = \169 $(DIRSRC)/test/read.jnl170 171 LIST_SRCFERRET_RST = \172 $(shell echo "$(LIST_SRCFERRET)" | \173 sed -e "s+$(DIRSRC)/test/+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \174 -e "s+\.jnl+.jnl.rst+g")175 176 LIST_SRCODV = \177 $(DIRSRC)/test/read.cmd178 179 LIST_SRCODV_RST = \180 $(shell echo "$(LIST_SRCODV)" | \181 sed -e "s+$(DIRSRC)/test/+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \182 -e "s+\.cmd+.cmd.rst+g")183 184 LIST_SRCPYTHON = \185 $(DIRSRC)/test/read.py186 107 187 108 .PHONY : \ … … 195 116 spellcheck \ 196 117 all \ 197 man \198 man_troff_sphinx \199 118 html \ 200 119 html_dev \ 201 html_dev_sphinx \202 html_dev_sphinx_one \203 120 html_user \ 204 121 pdf \ 205 122 pdf_dev \ 206 123 pdf_dev_sphinx \ 207 pdf_user \ 208 html_src_browser \ 209 html_src_browser_doxygen 124 pdf_user 210 125 211 126 help : … … 228 143 before : 229 144 @mkdir -p $(DIRWWW_DEV)/man/man1/ 230 @mkdir -p $(DIRWWW_DEV)/html/sphinx/231 @mkdir -p $(DIRWWW_DEV)/pdf/sphinx/232 @mkdir -p $(DIRTMP)/sphinx_tmpdir/doctrees/233 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/234 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/235 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig1236 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig2237 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig3238 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig4239 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig5240 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig6241 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig7242 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig8243 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig9244 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig10245 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig11246 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig12247 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig13248 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig14249 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig15250 @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig16251 @mkdir -p $(DIRTMP)/sphinx_tmpdir/guides/252 @mkdir -p $(DIRWWW_DEV)/src_browser/253 145 254 146 install_all : \ … … 256 148 install_html_user \ 257 149 install_pdf_dev \ 258 install_pdf_user \ 259 install_browser 150 install_pdf_user 260 151 261 152 install_html_dev : … … 270 161 install_pdf_user : 271 162 @$(DIRADM)/install.sh -w $(DIRWWW_USER)/pdf/ -u $(URLPUBLISH_USER)/pdf/ 272 273 install_browser :274 @$(DIRADM)/install.sh -w $(DIRWWW_DEV)/src_browser/doxygen/html/ -u $(URLPUBLISH_DEV)/src_browser/doxygen/html/275 163 276 164 clean : \ … … 279 167 -@rm -fr $(DIRWWW_DEV)/html/ 280 168 -@rm -fr $(DIRWWW_DEV)/pdf/ 281 -@rm -fr $(DIRWWW_DEV)/src_browser/169 cd ../docs/docs_dev/; make clean 282 170 cd $(DIRADM)/website/; make clean 283 171 284 172 285 173 cleantmp : 286 -@rm -f $(DIRTMP)/all.xml287 -@rm -f $(DIRTMP)/*.txt288 -@rm -f $(DIRTMP)/*.tex289 -@rm -fr $(DIRTMP)/sphinx_tmpdir/290 174 -@rm -f $(DIRTMP)/sphinx_*.log 291 292 design : \293 $(DIRDESIGN)/images/$(PRODUCT)_fulldependencies.png \294 $(DIRDESIGN)/images/$(PRODUCT)_fulldependencies.svg295 175 296 176 htmllinkcheckb : … … 313 193 html_dev \ 314 194 pdf_dev \ 315 man \ 316 html_src_browser 195 man_dev 317 196 318 197 all_user : \ … … 320 199 pdf_user 321 200 322 html_src_browser : \323 html_src_browser_doxygen324 325 man : \326 man_troff_sphinx327 328 man_troff_sphinx : \329 $(DIRADM)/sphinx/conf.py \330 $(DIRTMP)/sphinx_tmpdir/index_manuals.rst \331 $(LIST_SRCSH_RST) \332 $(LIST_SRCIDL_RST) \333 $(LIST_SRCMATLAB_RST) \334 $(LIST_SRCFERRET_RST) \335 $(LIST_SRCODV_RST) \336 $(LIST_SRCPYTHON)337 @sphinx-build -b man -c $(DIRADM)/sphinx \338 -d $(DIRTMP)/sphinx_tmpdir/doctrees/ \339 -d $(DIRTMP)/sphinx_tmpdir/doctrees/manuals/ \340 -w $(DIRTMP)/sphinx_man_troff.log \341 $(DIRTMP)/sphinx_tmpdir/ \342 $(DIRWWW_DEV)/man/man1/343 344 201 html : \ 345 202 html_user \ … … 353 210 html_dev_sphinx_one 354 211 355 html_dev_sphinx : \ 356 $(DIRADM)/sphinx/conf.py \ 357 $(DIRADM)/index.rst \ 358 $(DIRADM)/index_guides.rst \ 359 $(DIRTMP)/sphinx_tmpdir/index_manuals.rst \ 360 $(LIST_INVENTORY) \ 361 $(LIST_RST_GUIDES) \ 362 $(LIST_SRCSH_RST) \ 363 $(LIST_SRCIDL_RST) \ 364 $(LIST_SRCMATLAB_RST) \ 365 $(LIST_SRCFERRET_RST) \ 366 $(LIST_SRCODV_RST) \ 367 $(LIST_SRCPYTHON) 368 @cp $(DIRADM)/index.rst $(DIRTMP)/sphinx_tmpdir/ 369 @cp $(DIRADM)/index_guides.rst $(DIRTMP)/sphinx_tmpdir/ 370 @cp $(LIST_INVENTORY) $(DIRTMP)/sphinx_tmpdir/ 371 @cp $(LIST_SRCPYTHON) $(DIRTMP)/sphinx_tmpdir/manuals/ 372 @sphinx-build -b html -c $(DIRADM)/sphinx \ 373 -d $(DIRTMP)/sphinx_tmpdir/doctrees \ 374 -w $(DIRTMP)/sphinx_html.log \ 375 $(DIRTMP)/sphinx_tmpdir/ \ 376 $(DIRWWW_DEV)/html/sphinx/ 377 378 html_dev_sphinx_one : \ 379 $(DIRADM)/sphinx/conf.py \ 380 $(DIRADM)/index.rst \ 381 $(DIRADM)/index_guides.rst \ 382 $(DIRTMP)/sphinx_tmpdir/index_manuals.rst \ 383 $(LIST_INVENTORY) \ 384 $(LIST_RST_GUIDES) \ 385 $(LIST_SRCSH_RST) \ 386 $(LIST_SRCIDL_RST) \ 387 $(LIST_SRCMATLAB_RST) \ 388 $(LIST_SRCFERRET_RST) \ 389 $(LIST_SRCODV_RST) \ 390 $(LIST_SRCPYTHON) 391 @cp $(DIRADM)/index.rst $(DIRTMP)/sphinx_tmpdir/ 392 @cp $(DIRADM)/index_guides.rst $(DIRTMP)/sphinx_tmpdir/ 393 @cp $(LIST_INVENTORY) $(DIRTMP)/sphinx_tmpdir/ 394 @sphinx-build -b singlehtml -c $(DIRADM)/sphinx \ 395 -d $(DIRTMP)/sphinx_tmpdir/doctrees \ 396 -w $(DIRTMP)/sphinx_html_one.log \ 397 $(DIRTMP)/sphinx_tmpdir/ \ 398 $(DIRWWW_DEV)/html/sphinx_one/ 212 html_dev_sphinx : 213 cd ../docs/docs_dev; make html 214 215 html_dev_sphinx_one : 216 cd ../docs/docs_dev; make singlehtml 399 217 400 218 pdf : \ … … 405 223 cd $(DIRADM)/website/; make latexpdf 406 224 407 pdf_dev : \ 408 pdf_dev_sphinx 409 410 pdf_dev_sphinx : \ 411 $(DIRADM)/sphinx/conf.py \ 412 $(DIRADM)/index.rst \ 413 $(DIRADM)/index_guides.rst \ 414 $(DIRTMP)/sphinx_tmpdir/index_manuals.rst \ 415 $(LIST_INVENTORY) \ 416 $(LIST_RST_GUIDES) \ 417 $(LIST_SRCSH_RST) \ 418 $(LIST_SRCIDL_RST) \ 419 $(LIST_SRCMATLAB_RST) \ 420 $(LIST_SRCFERRET_RST) \ 421 $(LIST_SRCODV_RST) \ 422 $(LIST_SRCPYTHONS) 423 @cp $(DIRADM)/index.rst $(DIRTMP)/sphinx_tmpdir/ 424 @cp $(DIRADM)/index_guides.rst $(DIRTMP)/sphinx_tmpdir/ 425 @cp $(LIST_INVENTORY) $(DIRTMP)/sphinx_tmpdir/ 426 @sphinx-build -b latex -c $(DIRADM)/sphinx \ 427 -d $(DIRTMP)/sphinx_tmpdir/doctrees \ 428 -w $(DIRTMP)/sphinx_pdf_dev.log \ 429 $(DIRTMP)/sphinx_tmpdir/ \ 430 $(DIRTMP)/sphinx_tmpdir/latex_output 431 cd $(DIRTMP)/sphinx_tmpdir/latex_output/; make all-pdf 432 cp $(DIRTMP)/sphinx_tmpdir/latex_output/*.pdf \ 433 $(DIRWWW_DEV)/pdf/sphinx/ 434 435 $(DIRTMP)/sphinx_tmpdir/index_manuals.rst : 436 @echo ".. _index_manuals:" > $@ 437 @echo " " >> $@ 438 @echo "$(PRODUCTNAME) manuals" | tr [:print:] = >> $@ 439 @echo "$(PRODUCTNAME) manuals" >> $@ 440 @echo "$(PRODUCTNAME) manuals" | tr [:print:] = >> $@ 441 @echo " " >> $@ 442 @echo ".. only:: html" >> $@ 443 @echo " " >> $@ 444 @echo " **Download** offline version (\`.pdf <../../pdf/sphinx/$(PRODUCTNAME).pdf>\`__)" >> $@ 445 @echo " " >> $@ 446 @echo "Shell scripts" >> $@ 447 @echo "Shell scripts" | tr [:print:] = >> $@ 448 @echo ".. toctree::" >> $@ 449 @echo " :maxdepth: 1" 1>> $@ 450 @echo " :glob:" 1>> $@ 451 @echo " " >> $@ 452 @for file in $(LIST_SRCSH); \ 453 do \ 454 echo " manuals/$$(basename $${file})"; \ 455 done >> $@ 456 @echo " " >> $@ 457 @echo "IDL scripts" >> $@ 458 @echo "IDL scripts" | tr [:print:] = >> $@ 459 @echo ".. toctree::" >> $@ 460 @echo " :maxdepth: 1" 1>> $@ 461 @echo " :glob:" 1>> $@ 462 @echo " " >> $@ 463 @for file in $(LIST_SRCIDL); \ 464 do \ 465 echo " $${file}" | sed -e "s/src/manuals/"; \ 466 done >> $@ 467 @echo " " >> $@ 468 @echo "MATLAB scripts" >> $@ 469 @echo "MATLAB scripts" | tr [:print:] = >> $@ 470 @echo ".. toctree::" >> $@ 471 @echo " :maxdepth: 1" 1>> $@ 472 @echo " :glob:" 1>> $@ 473 @echo " " >> $@ 474 @for file in $(LIST_SRCMATLAB); \ 475 do \ 476 echo " manuals/$$(basename $${file})"; \ 477 done >> $@ 478 @echo " " >> $@ 479 @echo "FERRET scripts" >> $@ 480 @echo "FERRET scripts" | tr [:print:] = >> $@ 481 @echo ".. toctree::" >> $@ 482 @echo " :maxdepth: 1" 1>> $@ 483 @echo " :glob:" 1>> $@ 484 @echo " " >> $@ 485 @for file in $(LIST_SRCFERRET); \ 486 do \ 487 echo " manuals/$$(basename $${file})"; \ 488 done >> $@ 489 @echo " " >> $@ 490 @echo "ODV scripts" >> $@ 491 @echo "ODV scripts" | tr [:print:] = >> $@ 492 @echo ".. toctree::" >> $@ 493 @echo " :maxdepth: 1" 1>> $@ 494 @echo " :glob:" 1>> $@ 495 @echo " " >> $@ 496 @for file in $(LIST_SRCODV); \ 497 do \ 498 echo " manuals/$$(basename $${file})"; \ 499 done >> $@ 500 @echo " " >> $@ 501 @echo "PYTHON scripts" >> $@ 502 @echo "PYTHON scripts" | tr [:print:] = >> $@ 503 @echo ".. toctree::" >> $@ 504 @echo " :maxdepth: 1" 1>> $@ 505 @echo " :glob:" 1>> $@ 506 @echo " " >> $@ 507 @for file in $(LIST_SRCPYTHON); \ 508 do \ 509 echo " .. automodule:: $$(basename $${file})"; \ 510 done >> $@ 511 @echo " .. automodule::" 1>> $@ 512 @echo " :members:" 1>> $@ 513 @echo " " >> $@ 514 515 html_src_browser_doxygen : \ 516 $(DIRWWW_DEV)/src_browser/doxygen/ 517 518 $(DIRWWW_DEV)/src_browser/doxygen/ : \ 519 $(DIRADM)/Doxyfile_$(PRODUCT) \ 520 $(DIRADM)/m2cpp.pl \ 521 $(LIST_SRCFORTRAN) 522 @doxygen $< 523 @touch $@ 524 525 $(DIRTMP)/sphinx_tmpdir/manuals/%.sh.rst : $(DIRSRC)/%.sh $(DIRADM)/extract_rst.sh 526 @$(DIRADM)/extract_rst.sh -i $< -l sh -o $@ 527 528 $(DIRTMP)/sphinx_tmpdir/manuals/%.pro.rst : $(DIRSRC)/%.pro $(DIRADM)/extract_rst.sh 529 @$(DIRADM)/extract_rst.sh -i $< -l IDL -o $@ 530 531 $(DIRTMP)/sphinx_tmpdir/manuals/%.m.rst : $(DIRSRC)/test/%.m $(DIRADM)/extract_rst.sh 532 @$(DIRADM)/extract_rst.sh -i $< -l matlab -o $@ 533 534 $(DIRTMP)/sphinx_tmpdir/manuals/%.jnl.rst : $(DIRSRC)/test/%.jnl $(DIRADM)/extract_rst.sh 535 @$(DIRADM)/extract_rst.sh -i $< -l ferret -o $@ 536 537 $(DIRTMP)/sphinx_tmpdir/manuals/%.cmd.rst : $(DIRSRC)/test/%.cmd $(DIRADM)/extract_rst.sh 538 @$(DIRADM)/extract_rst.sh -i $< -l sh -o $@ 539 540 $(DIRADM)/sphinx_tmpdir/guides/%.rst : $(DIRADM)/guides/%.rst 541 @cp $< $@ 542 543 $(DIRDESIGN)/images/%.png : $(DIRDESIGN)/images/%.svg 544 @convert $< $@ 545 546 $(DIRDESIGN)/images/%.svg : $(DIRDESIGN)/%.dot 547 @dot -Tsvg -o $@ $< 548 549 $(DIRDESIGN)/$(PRODUCT)_fulldependencies.dot : \ 550 ./makefile 551 @makeppgraph --graphviz --output=$@ 225 pdf_dev : 226 cd ../docs/docs_dev; make latexpdf 227 228 man_dev : 229 cd ../docs/docs_dev; make man -
trunk/docs/docs_dev/Makefile
r157 r158 40 40 SPHINXBUILD = sphinx-build 41 41 PAPER = 42 BUILDDIR = _build42 BUILDDIR = ../../doc/ 43 43 44 44 # Internal variables. -
trunk/docs/docs_dev/source/guides/builddoc.rst
r141 r158 6 6 .. procedure to build and install doc 7 7 .. 8 .. SEE ALSO 9 .. ======== 10 .. 11 .. :ref:`Makefile` 12 .. 8 13 .. TODO 9 14 .. ===== … … 25 30 .. 26 31 .. $URL$ 32 .. 33 .. - fplod 20120206 34 .. 35 .. * new path for doc dev 27 36 .. 28 37 .. - fplod 20120223 … … 84 93 $ make html_dev_sphinx 85 94 86 et regarder le résultat dans :file:`../doc/html/ sphinx/index.html`.95 et regarder le résultat dans :file:`../doc/html/index.html`. 87 96 88 97 (bientôt) Si le résultat est convainquant, on peut produire les autres formats de … … 114 123 115 124 La mise à disposition des documentations produites ci-dessus sur l'URL 116 http://www.locean-ipsl.upmc.fr/~fplod/tropflux/tropflux_ws/doc/html/ sphinx/index.html et sur l'URL http://www.locean-ipsl.upmc.fr/tropflux/125 http://www.locean-ipsl.upmc.fr/~fplod/tropflux/tropflux_ws/doc/html/index.html et sur l'URL http://www.locean-ipsl.upmc.fr/tropflux/ 117 126 est réservée à Françoise Pinsard pour des raisons de protections de fichiers et 118 127 de politique de login.
Note: See TracChangeset
for help on using the changeset viewer.