Changeset 516 for trunk/docs


Ignore:
Timestamp:
04/13/12 11:41:05 (12 years ago)
Author:
pinsard
Message:

consolidation of doc dev. (to be cont.)

Location:
trunk/docs
Files:
7 added
1 copied
6 moved

Legend:

Unmodified
Added
Removed

  • trunk/docs/docs_dev/Makefile

    r515 r516  
     1#+ 
     2# 
     3# .. _Makefile: 
     4# ======== 
     5# Makefile 
     6# ======== 
     7# 
     8# DESCRIPTION 
     9# =========== 
     10# 
    111# Makefile for Sphinx documentation 
     12#  
     13# SEE ALSO 
     14# ======== 
    215# 
     16# :ref:`builddoc` 
     17# 
     18# :ref:`makefile_non_sphinx` 
     19#  
     20# TODO 
     21# ==== 
     22# 
     23# moins bourrin dans l'usage de makefile_non_sphinx et la génération du  
     24# logo 
     25# 
     26# update whith new sphinx backend 
     27#  
     28# EVOLUTIONS 
     29# ========== 
     30#  
     31# $Id: Makefile 30 2012-03-13 10:53:33Z pinsard $ 
     32# 
     33# $URL: svn+ssh://pinsard@forge.ipsl.jussieu.fr/ipsl/forge/projets/fptools/svn/trunk/docs/docs_dev/Makefile $ 
     34#  
     35# - fplod 20120413T082638Z cratos (Linux) 
     36#    
     37#   * add header 
     38#- 
    339 
     40# 
    441# You can set these variables from the command line. 
    5 SPHINXOPTS    = -c ./ 
     42SPHINXOPTS    = 
    643SPHINXBUILD   = sphinx-build 
    744PAPER         = 
    … …  
    1148PAPEROPT_a4     = -D latex_paper_size=a4 
    1249PAPEROPT_letter = -D latex_paper_size=letter 
    13 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ../sphinx_tmpdir/ 
     50ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source 
    1451 
    1552.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest 
    … …  
    2966 
    3067clean: 
     68        @make -f makefile_non_sphinx clean 
    3169        -rm -rf $(BUILDDIR)/* 
    3270 
    3371html: 
     72        @make -f makefile_non_sphinx all 
    3473        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 
    3574        @echo 
    … …  
    3776 
    3877dirhtml: 
     78        @make -f makefile_non_sphinx all 
    3979        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 
    4080        @echo 
    … …  
    4282 
    4383pickle: 
     84        @make -f makefile_non_sphinx all 
    4485        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 
    4586        @echo 
    … …  
    4788 
    4889json: 
     90        @make -f makefile_non_sphinx all 
    4991        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 
    5092        @echo 
    … …  
    5294 
    5395htmlhelp: 
     96        @make -f makefile_non_sphinx all 
    5497        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 
    5598        @echo 
    … …  
    58101 
    59102qthelp: 
     103        @make -f makefile_non_sphinx all 
    60104        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 
    61105        @echo 
    … …  
    67111 
    68112latex: 
     113        @make -f makefile_non_sphinx all 
    69114        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 
    70115        @echo 
    … …  
    74119 
    75120changes: 
     121        @make -f makefile_non_sphinx all 
    76122        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 
    77123        @echo 
    … …  
    79125 
    80126linkcheck: 
     127        @make -f makefile_non_sphinx all 
    81128        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 
    82129        @echo 
    … …  
    85132 
    86133doctest: 
     134        @make -f makefile_non_sphinx all 
    87135        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 
    88136        @echo "Testing of doctests in the sources finished, look at the " \ 

  • trunk/docs/docs_dev/makefile_non_sphinx

    r515 r516  
    11#+ 
    2 # 
    3 # .. _makefile: 
    4 # 
     2# .. _makefile_non_sphinx: 
     3# 
     4# =================== 
     5# makefile_non_sphinx 
     6# =================== 
     7# 
     8# DESCRIPTION 
     9# =========== 
     10# 
     11# génération des manuels à partir des fichiers non assimilables directement 
     12# par sphinx  
     13# 
     14# SEE ALSO 
    515# ======== 
    6 # makefile 
    7 # ======== 
    8 # 
    9 # administration of project varamma 
     16#  
     17# :ref:`builddoc` 
     18# 
     19# :ref:`Makefile` 
     20# 
     21# :ref:`extract_rst.sh` 
     22# 
     23# :ref:`for_doc.sh` 
    1024# 
    1125# TODO 
    1226# ==== 
     27# 
     28# improve dependencies 
    1329# 
    1430# autodoc not ok may be see  autodoc-process-docstring  
    … …  
    1834# continuation 
    1935# 
    20 # add -W to sphinx command when encoding problems are solved 
    21 # 
    22 # usage of sphinx/source/Makefile 
    23 # 
    2436# IDL and matlab in man_troff 
    25 # 
    26 # saxo inventory file should be provide by SAXO itself 
    27 # 
    28 # remove "-" before extract_demandandtest.sh : It is known now (20110303) 
    29 # that all demo and test are not ready but they should be at least on per 
    30 # file. 
    31 # 
    32 # find a way to order tests : now alphanumeric order (non-sens) 
    3337# 
    3438# EVOLUTIONS 
    … …  
    3842# 
    3943# $URL$ 
     44# 
     45# - fplod 20120413T083156Z cratos (Linux) 
     46#    
     47#   * creation from part of adm/makefile 
    4048# 
    4149# - fplod 20110907T122710Z aedon.locean-ipsl.upmc.fr (Darwin) 
    … …  
    244252#   * creation 
    245253# 
    246 # SEE ALSO 
    247 # ======== 
    248 # 
    249 # :ref:`extract_rst.sh` 
    250 # 
    251254#- 
    252255# 
    253 PRODUCT = \ 
    254 varamma 
    255  
    256 PRODUCTNAME = \ 
    257 $$(echo $(PRODUCT) | tr [:lower:] [:upper:]) 
    258  
    259 SUBPRODUCT = \ 
    260 varamma_ws 
    261  
    262 DIRSRC = \ 
    263 ../src/ 
    264  
    265 DIRADM = \ 
    266 ./ 
    267  
    268 DIRTMP = \ 
    269 ./ 
    270  
    271 DIRDESIGN = \ 
    272 ./design/ 
    273  
    274 DIRWWW = \ 
    275 ../doc/ 
    276  
    277 URLPUBLISH = \ 
    278 http://www.locean-ipsl.upmc.fr/~fplod/$(PRODUCT)/$(SUBPRODUCT)/doc/ 
    279  
    280 LIST_INVENTORY = \ 
    281 $(DIRADM)/saxo.inv 
    282  
    283 LIST_RST_GUIDES = \ 
    284 $(shell find $(DIRADM)/guides/ -name "*.rst") 
    285  
    286256LIST_SRCSH = \ 
    287 $(shell find $(DIRSRC) -name "*.sh" | sort) 
     257$(shell find ../.. ! \( -name '.svn' -prune \) -name "*.sh"; \ 
     258        echo "Makefile"; \ 
     259        echo "makefile_non_sphinx" \ 
     260        | sort) 
    288261 
    289262LIST_SRCSH_RST = \ 
    290 $(shell echo "$(LIST_SRCSH)" | \ 
    291         sed -e "s+$(DIRSRC)+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \ 
    292             -e "s+\.sh+.sh.rst+g") 
    293  
    294 LIST_SRCSH_TROFF = \ 
    295 $(shell echo "$(LIST_SRCSH)" | \ 
    296         sed -e "s+$(DIRSRC)+$(DIRWWW)/man/man1/+g" \ 
    297             -e "s+\.sh+.sh.1+g") 
     263        $(shell echo "$(LIST_SRCSH)" | \ 
     264        sed -e "s+../../adm+source/manuals/+g" \ 
     265        -e "s+../../src+source/manuals/+g" \ 
     266        -e "s+../../docs/docs_dev+source/manuals/+g" \ 
     267        -e "s+Makefile+source/manuals/Makefile.rst+g" \ 
     268        -e "s+makefile_non_sphinx+source/manuals/makefile_non_sphinx.rst+g" \ 
     269        -e "s+\.sh+.sh.rst+g") 
    298270 
    299271LIST_SRCIDL = \ 
    300 $(shell find $(DIRSRC) -name "*.pro" | sort) 
     272$(shell find ../.. ! \( -name '.svn' -prune \) -name "*.pro" | sort) 
    301273 
    302274LIST_SRCIDL_RST = \ 
    303275$(shell echo "$(LIST_SRCIDL)" | \ 
    304         sed -e "s+$(DIRSRC)+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \ 
     276        sed -e "s+\.\./\.\./src+source/manuals/+g" \ 
     277            -e "s+\.\./\.\.+source/manuals/+g" \ 
    305278            -e "s+\.pro+.pro.rst+g") 
    306279 
    307280LIST_SRCMATLAB = \ 
    308 $(shell find $(DIRSRC) -name "*.m" | grep -v external_matlab | sort) 
     281$(shell find ../.. ! \( -name '.svn' -prune \) -name "*.m" | \ 
     282        grep -v external_matlab | sort) 
    309283 
    310284LIST_SRCMATLAB_RST = \ 
    311285$(shell echo "$(LIST_SRCMATLAB)" | \ 
    312286        sed \ 
    313             -e "s+$(DIRSRC)/utilitaires+$(DIRTMP)/sphinx_tmpdir/manuals/utilitaires+g" \ 
    314             -e "s+$(DIRSRC)/external_matlab+$(DIRTMP)/sphinx_tmpdir/manuals/external_matlab+g" \ 
    315             -e "s+$(DIRSRC)+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \ 
     287            -e "s+../../utilitaires+source/manuals/utilitaires+g" \ 
     288            -e "s+../../src/+source/manuals/+g" \ 
    316289            -e "s+\.m+.m.rst+g") 
    317  
    318 LIST_SRCMATLAB_DEMO = \ 
    319 $(shell echo "$(LIST_SRCMATLAB)" | \ 
    320         sed -e "s+$(DIRSRC)+$(DIRTMP)/demo/+g" \ 
    321             -e "s+\.m+_demo.m+g") 
    322  
    323 LIST_SRCMATLAB_TEST = \ 
    324 $(shell echo "$(LIST_SRCMATLAB)" | \ 
    325         sed -e "s+$(DIRSRC)+$(DIRTMP)/test/+g" \ 
    326             -e "s+\.m+_test.m+g") 
    327290 
    328291LIST_SRCFERRET = \ 
    … …  
    331294LIST_SRCFERRET_RST = \ 
    332295$(shell echo "$(LIST_SRCFERRET)" | \ 
    333         sed -e "s+$(DIRSRC)+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \ 
     296        sed -e "s+../../src/+source/manuals/+g" \ 
    334297            -e "s+\.jnl+.jnl.rst+g") 
    335298 
    336 LIST_SRCPYTHON = \ 
    337 $(shell find $(DIRSRC) -name "*.py" | sort) 
     299LIST_RST = \ 
     300$(shell echo $(LIST_SRCSH_RST) \ 
     301$(LIST_SRCIDL_RST) \ 
     302$(LIST_SRCFERRET_RST) \ 
     303$(LIST_SRCODV_RST) \ 
     304$(LIST_SRCMATLAB_RST) | tr ' ' '\n' | sort | tr '\n' ' ') 
    338305 
    339306.PHONY : \ 
    340307help \ 
    341 before \ 
    342308clean \ 
    343 cleantmp \ 
    344 design \ 
    345 htmllinkcheckb \ 
    346 htmllinkchecka \ 
    347 spellcheck \ 
    348 all \ 
    349 man \ 
    350 man_troff_sphinx \ 
    351 html \ 
    352 html_sphinx \ 
    353 html_sphinx_one \ 
    354 pdf \ 
    355 pdf_sphinx \ 
    356 html_src_browser \ 
    357 html_src_browser_doxygen \ 
    358 matlab_demo \ 
    359 matlab_test 
     309all 
    360310 
    361311help : 
    362         @echo "Prepare output directories :" 
    363         @echo "\$$ make before" 
    364         @echo "" 
    365312        @echo "Following commands are available to build outputs :" 
    366         @echo "\$$ make all" 
    367         @echo " " 
    368         @echo "Check links before installation : " 
    369         @echo "\$$ make htmllinkcheckb" 
    370         @echo " " 
    371         @echo "Last step = installation of HTML and pdf files" 
    372         @echo "\$$ make install_all" 
    373         @echo " " 
    374         @echo "Check links after installation : " 
    375         @echo "\$$ make htmllinkchecka" 
    376         @echo " " 
    377  
    378 before : 
    379         @mkdir -p $(DIRWWW)/man/man1/ 
    380         @mkdir -p $(DIRWWW)/html/sphinx/ 
    381         @mkdir -p $(DIRWWW)/pdf/sphinx/ 
    382         @mkdir -p $(DIRTMP)/sphinx_tmpdir/doctrees/ 
    383         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/ 
    384         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/utilitaires/ 
    385         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/external_matlab/ 
    386         @mkdir -p $(DIRTMP)/sphinx_tmpdir/guides/ 
    387         @mkdir -p $(DIRWWW)/src_browser/ 
    388         @mkdir -p $(DIRTMP)/demo/ 
    389         @mkdir -p $(DIRTMP)/test/ 
    390  
    391  
    392 install_all : \ 
    393 install_html \ 
    394 install_pdf \ 
    395 install_browser 
    396  
    397 install_html : 
    398         @$(DIRADM)/install.sh -w $(DIRWWW)/html/ -u $(URLPUBLISH)/html/ 
    399  
    400 install_pdf : 
    401         @$(DIRADM)/install.sh -w $(DIRWWW)/pdf/ -u $(URLPUBLISH)/pdf/ 
    402  
    403 install_browser : 
    404         @$(DIRADM)/install.sh -w $(DIRWWW)/src_browser/doxygen/html/ -u $(URLPUBLISH)/src_browser/doxygen/html/ 
    405  
    406 clean : \ 
    407 cleantmp 
    408         -@rm -fr $(DIRWWW)/man/ 
    409         -@rm -fr $(DIRWWW)/html/ 
    410         -@rm -fr $(DIRWWW)/pdf/ 
    411         -@rm -fr $(DIRWWW)/src_browser/ 
    412  
    413  
    414 cleantmp : 
    415         -@rm -f $(DIRTMP)/all.xml 
    416         -@rm -f $(DIRTMP)/*.txt 
    417         -@rm -f $(DIRTMP)/*.tex 
    418         -@rm -fr $(DIRTMP)/sphinx_tmpdir/ 
    419         -@rm -f $(DIRTMP)/sphinx_*.log 
    420         -@rm -rf $(DIRTMP)/demo/ 
    421         -@rm -rf $(DIRTMP)/test/ 
    422  
    423 design : \ 
    424 $(DIRDESIGN)/images/$(PRODUCT)_fulldependencies.png \ 
    425 $(DIRDESIGN)/images/$(PRODUCT)_fulldependencies.svg 
    426  
    427 htmllinkcheckb : 
    428         @$(DIRADM)/linkchecker.sh -d $(DIRWWW)/html/ 
    429  
    430 htmllinkchecka : 
    431         @$(DIRADM)/linkchecker.sh -u $(URLPUBLISH) 
    432  
    433 spellcheck : 
    434         @++aspell --mode=sgml --master=english -c \ 
    435         $(DIRSRC)/$(PRODUCT).xml 
     313        @echo "\$$ make -f makefile_non_sphinx clean" 
     314        @echo "\$$ make -f makefile_non_sphinx all" 
     315 
     316clean : 
     317        -@rm source/manuals/myimage*.png 
     318        -@rm $(LIST_RST) 2> /dev/null 
     319        -@rm source/manuals/manuals_non_sphinx.rst 2> /dev/null 
    436320 
    437321all : \ 
    438 man \ 
    439 html_src_browser 
    440  
    441 html_src_browser : \ 
    442 html_src_browser_doxygen 
    443  
    444 man : \ 
    445 man_troff_sphinx 
    446  
    447 man_troff_sphinx : \ 
    448 $(DIRADM)/sphinx/conf.py \ 
    449 $(DIRTMP)/sphinx_tmpdir/index_manuals.rst \ 
    450 $(LIST_INVENTORY) \ 
    451 $(LIST_SRCSH_RST) \ 
    452 $(LIST_SRCPYTHON) \ 
    453 $(LIST_SRCIDL_RST) \ 
    454 $(LIST_SRCMATLAB_RST) \ 
    455 $(LIST_SRCFERRET_RST) 
    456         @cp $(DIRADM)/index.rst $(DIRTMP)/sphinx_tmpdir/ 
    457         @cp $(DIRADM)/index_guides.rst $(DIRTMP)/sphinx_tmpdir/ 
    458         @cp $(LIST_RST_GUIDES) $(DIRTMP)/sphinx_tmpdir/guides/ 
    459         @cp $(LIST_INVENTORY) $(DIRTMP)/sphinx_tmpdir/ 
    460         @sphinx-build -b man -c $(DIRADM)/sphinx \ 
    461             -d $(DIRTMP)/sphinx_tmpdir/doctrees/ \ 
    462             -d $(DIRTMP)/sphinx_tmpdir/doctrees/manuals/ \ 
    463             -w $(DIRTMP)/sphinx_man_troff.log \ 
    464             $(DIRTMP)/sphinx_tmpdir/ \ 
    465             $(DIRWWW)/man/man1/ 
    466  
    467 html : \ 
    468 html_sphinx \ 
    469 html_sphinx_one 
    470  
    471 html_sphinx : \ 
    472 $(DIRADM)/sphinx/conf.py \ 
    473 $(DIRADM)/index.rst \ 
    474 $(DIRADM)/index_guides.rst \ 
    475 $(DIRTMP)/sphinx_tmpdir/index_manuals.rst \ 
    476 $(LIST_INVENTORY) \ 
    477 $(LIST_RST_GUIDES) \ 
    478 $(LIST_SRCSH_RST) \ 
    479 $(LIST_SRCPYTHON) \ 
    480 $(LIST_SRCIDL_RST) \ 
    481 $(LIST_SRCMATLAB_RST) \ 
    482 $(LIST_SRCFERRET_RST) 
    483         @cp $(DIRADM)/index.rst $(DIRTMP)/sphinx_tmpdir/ 
    484         @cp $(DIRADM)/index_guides.rst $(DIRTMP)/sphinx_tmpdir/ 
    485         @cp $(LIST_RST_GUIDES) $(DIRTMP)/sphinx_tmpdir/guides/ 
    486         @cp $(LIST_INVENTORY) $(DIRTMP)/sphinx_tmpdir/ 
    487         @sphinx-build -b html -c $(DIRADM)/sphinx \ 
    488             -d $(DIRTMP)/sphinx_tmpdir/doctrees \ 
    489             -w $(DIRTMP)/sphinx_html.log \ 
    490             $(DIRTMP)/sphinx_tmpdir/ \ 
    491             $(DIRWWW)/html/sphinx/ 
    492  
    493 html_sphinx_one : \ 
    494 $(DIRADM)/sphinx/conf.py \ 
    495 $(DIRADM)/index.rst \ 
    496 $(DIRADM)/index_guides.rst \ 
    497 $(DIRTMP)/sphinx_tmpdir/index_manuals.rst \ 
    498 $(LIST_INVENTORY) \ 
    499 $(LIST_RST_GUIDES) \ 
    500 $(LIST_SRCSH_RST) \ 
    501 $(LIST_SRCPYTHON) \ 
    502 $(LIST_SRCIDL_RST) \ 
    503 $(LIST_SRCMATLAB_RST) \ 
    504 $(LIST_SRCFERRET_RST) 
    505         @cp $(DIRADM)/index.rst $(DIRTMP)/sphinx_tmpdir/ 
    506         @cp $(DIRADM)/index_guides.rst $(DIRTMP)/sphinx_tmpdir/ 
    507         @cp $(LIST_RST_GUIDES) $(DIRTMP)/sphinx_tmpdir/guides/ 
    508         @cp $(LIST_INVENTORY) $(DIRTMP)/sphinx_tmpdir/ 
    509         @sphinx-build -b singlehtml -c $(DIRADM)/sphinx \ 
    510             -d $(DIRTMP)/sphinx_tmpdir/doctrees \ 
    511             -w $(DIRTMP)/sphinx_html_one.log \ 
    512             $(DIRTMP)/sphinx_tmpdir/ \ 
    513             $(DIRWWW)/html/sphinx_one/ 
    514  
    515 pdf : \ 
    516 pdf_sphinx 
    517  
    518 pdf_sphinx : \ 
    519 $(DIRADM)/sphinx/conf.py \ 
    520 $(DIRADM)/index.rst \ 
    521 $(DIRADM)/index_guides.rst \ 
    522 $(DIRTMP)/sphinx_tmpdir/index_manuals.rst \ 
    523 $(LIST_INVENTORY) \ 
    524 $(LIST_RST_GUIDES) \ 
    525 $(LIST_SRCSH_RST) \ 
    526 $(LIST_SRCPYTHON) \ 
    527 $(LIST_SRCIDL_RST) \ 
    528 $(LIST_SRCMATLAB_RST) \ 
    529 $(LIST_SRCFERRET_RST) 
    530         @cp $(DIRADM)/index.rst $(DIRTMP)/sphinx_tmpdir/ 
    531         @cp $(DIRADM)/index_guides.rst $(DIRTMP)/sphinx_tmpdir/ 
    532         @cp $(LIST_RST_GUIDES) $(DIRTMP)/sphinx_tmpdir/guides/ 
    533         @cp $(LIST_INVENTORY) $(DIRTMP)/sphinx_tmpdir/ 
    534         @sphinx-build -b latex -c $(DIRADM)/sphinx \ 
    535             -d $(DIRTMP)/sphinx_tmpdir/doctrees \ 
    536             -w $(DIRTMP)/sphinx_pdf.log \ 
    537             $(DIRTMP)/sphinx_tmpdir/ \ 
    538             $(DIRTMP)/sphinx_tmpdir/latex_output 
    539         cd $(DIRTMP)/sphinx_tmpdir/latex_output/; make all-pdf 
    540         cp $(DIRTMP)/sphinx_tmpdir/latex_output/*.pdf \ 
    541            $(DIRWWW)/pdf/sphinx/ 
    542  
    543 $(DIRTMP)/sphinx_tmpdir/index_manuals.rst : 
    544         @-mkdir $(DIRTMP)/sphinx_tmpdir/ 
    545         @echo ".. _index_manuals:" > $@ 
    546         @echo " " >> $@ 
    547         @echo "$(PRODUCTNAME) manuals" | tr [:print:] = >> $@ 
    548         @echo "$(PRODUCTNAME) manuals" >> $@ 
    549         @echo "$(PRODUCTNAME) manuals" | tr [:print:] = >> $@ 
    550         @echo " " >> $@ 
    551         @echo ".. only:: html" >> $@ 
    552         @echo " " >> $@ 
    553         @echo "   **Download** offline version (\`.pdf <../../pdf/sphinx/$(PRODUCTNAME).pdf>\`__)" >> $@ 
    554         @echo " " >> $@ 
    555         @echo "Shell scripts" >> $@ 
    556         @echo "Shell scripts" | tr [:print:] = >> $@ 
     322source/manuals/manuals_non_sphinx.rst \ 
     323$(LIST_RST) 
     324        @for_doc.sh 
     325 
     326source/manuals/manuals_non_sphinx.rst : \ 
     327$(LIST_RST) 
     328        @echo ".. _manuals_non_sphinx:" > $@ 
     329        @echo " " >> $@ 
     330        @echo " " >> $@ 
     331        @echo "non sphinx manuals" | tr [:print:] = >> $@ 
     332        @echo "non sphinx manuals" >> $@ 
     333        @echo "non sphinx manuals" | tr [:print:] = >> $@ 
     334        @echo " " >> $@ 
    557335        @echo ".. toctree::" >> $@ 
    558         @echo "   :maxdepth: 1" 1>> $@ 
    559         @echo "   :glob:" 1>> $@ 
    560         @echo " " >> $@ 
    561         @for file in $(LIST_SRCSH); \ 
     336        @echo "   :maxdepth: 1" >> $@ 
     337        @echo "   :glob:" >> $@ 
     338        @echo " " >> $@ 
     339        @echo $(LIST_RST) 
     340        @for file in $(LIST_RST); \ 
    562341        do \ 
    563            echo "   manuals/$$(basename $${file})"; \ 
     342                echo "   $$(basename $${file} .rst)"; \ 
     343                echo " "; \ 
    564344        done >> $@ 
    565345        @echo " " >> $@ 
    566         @echo "PYTHON scripts" >> $@ 
    567         @echo "PYTHON scripts" | tr [:print:] = >> $@ 
    568         @echo ".. toctree::" >> $@ 
    569         @echo "   :maxdepth: 1" 1>> $@ 
    570         @echo "   :glob:" 1>> $@ 
    571         @echo " " >> $@ 
    572         @for file in $(LIST_SRCPYTHON); \ 
    573         do \ 
    574            echo "   .. automodule:: src.$$(basename $${file} .py).$$(basename $${file} .py)"; \ 
    575            echo "      :members:"; \ 
    576         done >> $@ 
    577         @echo " " >> $@ 
    578         @echo "IDL scripts" >> $@ 
    579         @echo "IDL scripts" | tr [:print:] = >> $@ 
    580         @echo ".. toctree::" >> $@ 
    581         @echo "   :maxdepth: 1" 1>> $@ 
    582         @echo "   :glob:" 1>> $@ 
    583         @echo " " >> $@ 
    584         @for file in $(LIST_SRCIDL); \ 
    585         do \ 
    586            echo "   manuals/$$(basename $${file})"; \ 
    587         done >> $@ 
    588         @echo " " >> $@ 
    589         @echo "MATLAB scripts" >> $@ 
    590         @echo "MATLAB scripts" | tr [:print:] = >> $@ 
    591         @echo ".. toctree::" >> $@ 
    592         @echo "   :maxdepth: 1" 1>> $@ 
    593         @echo "   :glob:" 1>> $@ 
    594         @echo " " >> $@ 
    595         @for file in $(LIST_SRCMATLAB); \ 
    596         do \ 
    597            echo "   manuals/$$(dirname $${file})/$$(basename $${file})" | sed -e "s+\.\./src/++"; \ 
    598         done >> $@ 
    599         @echo " " >> $@ 
    600         @echo "FERRET scripts" >> $@ 
    601         @echo "FERRET scripts" | tr [:print:] = >> $@ 
    602         @echo ".. toctree::" >> $@ 
    603         @echo "   :maxdepth: 1" 1>> $@ 
    604         @echo "   :glob:" 1>> $@ 
    605         @echo " " >> $@ 
    606         @for file in $(LIST_SRCFERRET); \ 
    607         do \ 
    608            echo "   manuals/$$(basename $${file})"; \ 
    609         done >> $@ 
    610         @echo " " >> $@ 
    611  
    612 html_src_browser_doxygen : \ 
    613         $(DIRWWW)/src_browser/doxygen/ 
    614  
    615 $(DIRWWW)/src_browser/doxygen/ : \ 
    616 $(DIRADM)/Doxyfile_$(PRODUCT) \ 
    617 $(DIRADM)/m2cpp.pl \ 
    618 $(LIST_SRCMATLAB) \ 
    619 $(LIST_SRCFORTRAN) 
    620         @doxygen $< 
    621         @touch $@ 
    622  
    623 matlab_demo : \ 
    624 $(LIST_SRCMATLAB_DEMO) 
    625  
    626 matlab_test : \ 
    627 $(LIST_SRCMATLAB_TEST) 
    628  
    629 $(DIRTMP)/sphinx_tmpdir/manuals/%.sh.rst : $(DIRSRC)/%.sh $(DIRADM)/extract_rst.sh 
    630         @$(DIRADM)/extract_rst.sh -i $< -l sh -o $@ 
    631  
    632 $(DIRTMP)/sphinx_tmpdir/manuals/%.pro.rst : $(DIRSRC)/%.pro $(DIRADM)/extract_rst.sh 
    633         @$(DIRADM)/extract_rst.sh -i $< -l IDL -o $@ 
    634  
    635 $(DIRTMP)/sphinx_tmpdir/manuals/%.m.rst : $(DIRSRC)/%.m $(DIRADM)/extract_rst.sh 
    636         @$(DIRADM)/extract_rst.sh -i $< -l matlab -o $@ 
    637  
    638 $(DIRTMP)/sphinx_tmpdir/manuals/utilitaires/%.m.rst : $(DIRSRC)/utilitaires/%.m $(DIRADM)/extract_rst.sh 
    639         @$(DIRADM)/extract_rst.sh -i $< -l matlab -o $@ 
    640  
    641 $(DIRTMP)/sphinx_tmpdir/manuals/external_matlab/%.m.rst : $(DIRSRC)/external_matlab/%.m $(DIRADM)/extract_rst.sh 
    642         @$(DIRADM)/extract_rst.sh -i $< -l matlab -o $@ 
    643  
    644 $(DIRTMP)/demo/%_demo.m : $(DIRSRC)/%.m $(DIRADM)/extract_demoandtest.sh 
    645         -@$(DIRADM)/extract_demoandtest.sh -i $< -m demo -o $@ 
    646  
    647 $(DIRTMP)/test/%_test.m : $(DIRSRC)/%.m $(DIRADM)/extract_demoandtest.sh 
    648         -@$(DIRADM)/extract_demoandtest.sh -i $< -m test -o $@ 
    649  
    650 $(DIRTMP)/sphinx_tmpdir/manuals/%.jnl.rst : $(DIRSRC)/%.jnl  $(DIRADM)/extract_rst.sh 
    651         @$(DIRADM)/extract_rst.sh -i $< -l ferret -o $@ 
    652  
    653 $(DIRDESIGN)/images/%.png : $(DIRDESIGN)/images/%.svg 
    654         @convert $< $@ 
    655  
    656 $(DIRDESIGN)/images/%.svg : $(DIRDESIGN)/%.dot 
    657         @dot -Tsvg -o $@ $< 
    658  
    659 $(DIRDESIGN)/$(PRODUCT)_fulldependencies.dot : \ 
    660 ./makefile 
    661         @makeppgraph --graphviz --output=$@ 
     346 
     347source/manuals/%.sh.rst : ../../src/%.sh 
     348        @extract_rst.sh -i $< -l sh -o $@ 
     349 
     350source/manuals/%.sh.rst : ../../adm/%.sh 
     351        @extract_rst.sh -i $< -l sh -o $@ 
     352 
     353source/manuals/makefile_non_sphinx.rst : ../../docs/docs_dev/makefile_non_sphinx 
     354        @extract_rst.sh -i $< -l sh -o $@ 
     355 
     356source/manuals/Makefile.rst : ../../docs/docs_dev/Makefile 
     357        @extract_rst.sh -i $< -l sh -o $@ 
     358 
     359source/manuals/%.pro.rst : ../../src/%.pro 
     360        @extract_rst.sh -i $< -l IDL -o $@ 
     361 
     362source/manuals/%.pro.rst : ../../%.pro 
     363        @extract_rst.sh -i $< -l IDL -o $@ 
     364 
     365source/manuals/%.m.rst : ../../src/%.m  
     366        @extract_rst.sh -i $< -l matlab -o $@ 
     367 
     368source/manuals/utilitaires/%.m.rst : ../../src/utilitaires/%.m 
     369        @extract_rst.sh -i $< -l matlab -o $@ 
     370 
     371source/manuals/external_matlab/%.m.rst : ../../src/external_matlab/%.m 
     372        @extract_rst.sh -i $< -l matlab -o $@ 
     373 
     374source/manuals/%.jnl.rst : ../../src/%.jnl   
     375        @extract_rst.sh -i $< -l ferret -o $@ 

  • trunk/docs/docs_dev/source/conf.py

    r515 r516  
    1919# 
    2020#   * find a way to produce olr_split.sh.1 even if graphviz inside source 
    21 #   * find a way to avoid hard coded man pages name here (should be in  
     21#   * find a way to avoid hard coded man pages name here (should be in 
    2222#     adm/makefile) 
    2323#   * use a specific index.rst for man troff 
    … …  
    6161# add these directories to sys.path here. If the directory is relative to the 
    6262# documentation root, use os.path.abspath to make it absolute, like shown here. 
    63 sys.path.append(os.path.abspath('../../src/')) 
    64 sys.path.append(os.path.abspath('../src/')) 
    65 sys.path.append(os.path.abspath('../')) 
    66 sys.path.append(os.path.abspath('../..')) 
     63#sys.path.insert(0, os.path.abspath('.')) 
     64sys.path.insert(0, os.path.abspath('../../../src/')) 
    6765 
    6866# -- General configuration ----------------------------------------------------- 
    … …  
    7169# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    7270#extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig'] 
    73 extensions = ['sphinx.ext.autodoc',  
    74               'sphinx.ext.doctest',  
     71extensions = ['sphinx.ext.autodoc', 
     72              'sphinx.ext.doctest', 
    7573              'sphinx.ext.todo', 
    76               'sphinx.ext.intersphinx',  
    77               'sphinx.ext.coverage',  
    78               'sphinx.ext.pngmath',  
    79               'sphinx.ext.ifconfig',  
    80               'sphinx.ext.viewcode',  
     74              'sphinx.ext.intersphinx', 
     75              'sphinx.ext.coverage', 
     76              'sphinx.ext.pngmath', 
     77              'sphinx.ext.ifconfig', 
     78              'sphinx.ext.viewcode', 
    8179              'sphinx.ext.graphviz', 
    8280              'sphinx.ext.inheritance_diagram' ] 
    … …  
    9694# General information about the project. 
    9795project = u'VARAMMA' 
    98 copyright = u'2011, CNRS' 
     96copyright = u'2011,2012, CNRS' 
    9997 
    10098# The version info for the project you're documenting, acts as replacement for 

  • trunk/docs/docs_dev/source/index.rst

    r515 r516  
    3030   :maxdepth: 2 
    3131 
    32    index_guides 
    33    index_manuals.rst 
     32   index_guides.rst 
     33   manuals/index.rst 
    3434 
    3535   guides/bibliography.rst 
Note: See TracChangeset for help on using the changeset viewer.