Changeset 115 for trunk/adm


Ignore:
Timestamp:
02/09/12 18:57:16 (12 years ago)
Author:
pinsard
Message:

add procedure for data update, reorganize guide outlines

Location:
trunk/adm
Files:
1 added
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/adm/guides/builddoc.rst

    r110 r115  
    11.. + 
     2.. 
     3.. DESCRIPTION 
     4.. =========== 
     5.. 
     6.. procedure to build and install doc 
    27.. 
    38.. TODO 
    … …  
    1116.. 
    1217.. checklink 
    13 ..  
     18.. 
     19.. PDF pas encore diffusé car pb numérotation exotique par sphinx de graphiques 
     20.. 
    1421.. EVOLUTIONS 
    1522.. ========== 
     23.. 
     24.. $Id$ 
     25.. 
     26.. $URL$ 
     27.. 
     28.. - fplod 20120209 
     29.. 
     30..   * as this file is know cited in index_guide.rst, change section levels 
    1631.. 
    1732.. - fplod 20110628T133328Z aedon.locean-ipsl.upmc.fr (Darwin) 
    … …  
    2035.. 
    2136.. - fplod 20110628T132733Z aedon.locean-ipsl.upmc.fr (Darwin) 
    22 ..  
     37.. 
    2338..   * add instruction for website 
    2439.. 
    … …  
    3449 
    3550Build Documentation 
    36 ------------------- 
     51=================== 
     52 
     53You will find here 
     54how to build HTML, PDF and troff versions of documentations. 
    3755 
    3856Documentation |project| 
    39 ~~~~~~~~~~~~~~~~~~~~~~~ 
    40 La documentation est construite à partir des fichiers ReStructuredText_  
    41 dans :file:`${TROPFLUX}/adm/` et des commentaires dans les sources  
     57----------------------- 
     58 
     59La documentation est construite à partir des fichiers ReStructuredText_ 
     60dans :file:`${TROPFLUX}/adm/` et des commentaires dans les sources 
    4261sous :file:`${TROPFLUX}/src/`. 
    4362 
    … …  
    5069.. parsed-literal:: 
    5170 
    52  $ cd ${|project|}/adm/ 
    53  $ make clean 
    54  $ make before 
    55  $ make html_dev_sphinx 
     71   $ cd ${|project|}/adm/ 
     72   $ make clean 
     73   $ make before 
     74   $ make html_dev_sphinx 
    5675 
    5776et regarder le résultat dans :file:`../doc/html/sphinx/index.html`. 
    5877 
    59 Si le résultat est convainquant, on peut produire les autres formats de  
     78(bientôt) Si le résultat est convainquant, on peut produire les autres formats de 
    6079documentations (HTML single, PDF et troff): 
    6180 
    6281.. parsed-literal:: 
    6382 
    64  $ make all_dev 
     83   $ make all_dev 
    6584 
    6685Website |project| 
    67 ~~~~~~~~~~~~~~~~~ 
     86----------------- 
    6887 
    69 La documentation est construite à partir des fichiers ReStructuredText_  
     88La documentation est construite à partir des fichiers ReStructuredText_ 
    7089dans :file:`${TROPFLUX}/adm/website`. 
    7190 
    … …  
    7493.. parsed-literal:: 
    7594 
    76  $ cd ${|project|}/adm/ 
    77  $ make clean 
    78  $ make before 
    79  $ make html_user 
     95   $ cd ${|project|}/adm/ 
     96   $ make clean 
     97   $ make before 
     98   $ make html_user 
    8099 
    81100et regarder le résultat dans :file:`./website/_build/html/index.html`. 
    82101 
    83102Install Documentation |project| 
    84 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     103------------------------------- 
    85104 
    86105La mise à disposition des documentations produites ci-dessus sur l'URL 
    87 http://www.locean-ipsl.upmc.fr/~fplod/tropflux/tropflux_ws/doc/html/sphinx/index.html 
     106http://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/ 
    88107est réservée à Françoise Pinsard pour des raisons de protections de fichiers et 
    89108de politique de login. 
    … …  
    93112.. parsed-literal:: 
    94113 
    95  $ make install_all 
     114   $ make install_all 

  • trunk/adm/guides/contributing.rst

    r110 r115  
    33.. EVOLUTIONS 
    44.. ========== 
     5.. 
     6.. $Id$ 
     7.. 
     8.. $URL$ 
     9.. 
     10.. - fplod 20120209 
     11.. 
     12..   * builddoc move in index_guides.rst 
    513.. 
    614.. - fplod 20101220T114420Z aedon.locean-ipsl.upmc.fr (Darwin) 
    … …  
    1523 
    1624============== 
    17  Contributing 
     25Contributing 
    1826============== 
    1927 
    … …  
    3240You will find in 
    3341:ref:`svn Basic Commands <svnbasiccommands>` how to commit your change 
    34  
    35 You will find in 
    36 :ref:`builddoc` how to build HTML, PDF and troff versions of documentations. 

  • trunk/adm/index_guides.rst

    r110 r115  
    1111.. ========== 
    1212.. 
     13.. $Id$ 
     14.. 
     15.. $URL$ 
     16.. 
     17.. - fplod 20120209 
     18.. 
     19..   * add builddoc and updatedata 
    1320.. 
    1421.. - fplod 20101122T171327Z aedon.locean-ipsl.upmc.fr (Darwin) 
    … …  
    2936 
    3037   guides/data_content 
     38   guides/updatedata 
     39   guides/builddoc 
    3140   guides/coding_rules 
    3241 
Note: See TracChangeset for help on using the changeset viewer.