Changeset 36


Ignore:
Timestamp:
04/01/11 16:27:14 (13 years ago)
Author:
pinsard
Message:

add end users website production

Location:
trunk/adm
Files:
23 added
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/adm/guides/coding_rules.rst

    r2 r36  
    1313.. emphase good and bad examples 
    1414.. 
     15.. ne pas utiliser de mot clé : ex test en shell, image en matlab  
     16.. 
    1517.. EVOLUTIONS 
    1618.. ========== 
     19.. 
     20.. $URL$ 
     21.. 
     22.. - fplod 20110308T100953Z aedon.locean-ipsl.upmc.fr (Darwin) 
     23.. 
     24..   * small improvements. add ref to runtestdemo. 
     25.. 
     26.. - fplod 20110303T160756Z aedon.locean-ipsl.upmc.fr (Darwin) 
     27.. 
     28..   * add octave/matlab section 
    1729.. 
    1830.. - fplod 20101125T075803Z aedon.locean-ipsl.upmc.fr (Darwin) 
    … …  
    3547 
    3648IDL scripts : :file:`.pro` 
     49 
     50Octave/Matlab scripts : :file:`.m` 
     51 
    3752 
    3853Files contents 
    … …  
    4156No multiple statement  
    4257 
    43 example:: 
     58bad:: 
    4459 
    4560 a=1;b=2 
    4661 
    47 :: 
     62good:: 
    4863 
    4964 a=1 
    … …  
    5267No comment after a statement 
    5368 
    54 example:: 
     69 
     70bad:: 
    5571 
    5672 yyyy=2010 # default yyyy value 
    5773 
    58 :: 
     74good:: 
    5975 
    6076 # default yyyy value 
    … …  
    6480~~~~~~~~~~~~ 
    6581 
    66 Lines length should be shorter than 79 caracters. 
     82Lines length should be shorter than 79 characters. 
    6783 
    6884Exception : long URL 
    … …  
    106122~~~~~~~~~~~ 
    107123 
    108 Unabbriviated keywords 
     124Unabbreviated keywords 
    109125...................... 
    110126 
    … …  
    145161 justification : error handling, portability (unix, windows) 
    146162 
    147 .. +todo idem for matlab with :command:`!` 
    148  
    149163Test with NaN 
    150164............. 
    … …  
    170184  
    171185 +- espilon machin 
     186 
     187 
     188Octave/Matlab scripts 
     189~~~~~~~~~~~~~~~~~~~~~ 
     190 
     191Footers 
     192....... 
     193 
     194Add demo and test 
     195 
     196 justification : robustness 
     197 
     198 see :ref:`rundemotest` 
     199 
     200Functions 
     201......... 
     202 
     203Use function calling form rather than procedure 
     204 
     205 justification : error handling 
     206 
     207bad :: 
     208 
     209  load ginette 
     210     
     211good :: 
     212 
     213  data=load('ginette') 
     214 
     215Interaction with system 
     216....................... 
     217 
     218No :command:`!` 
     219 
     220 justification : error handling, portability (unix, windows) 
     221 
     222bad:: 
     223   
     224  !echo $ARCH 
     225 
     226good:: 
     227 
     228  my_ev=getenv('ARCH') 
     229 
     230Test with float 
     231............... 
     232 
     233bad :: 
     234 
     235 myvar1 == myvar2 
     236 
     237good+todo+:: 
     238  
     239 matlab +- espilon machin 
     240 octave assert(myvar1,myvar2) 
     241 
     242IF block 
     243........ 
     244 
     245always an :command:`else` if :command:`elseif` 
     246 
     247switch block 
     248............ 
     249 
     250always an :command:`otherwise` 
     251 

  • trunk/adm/makefile

    r34 r36  
    2323# ========== 
    2424# 
     25# - fplod 20110401T091241Z aedon.locean-ipsl.upmc.fr (Darwin) 
     26# 
     27#   * replace URLPUBLISH by URLPUBLISH_DEV 
     28#   * replace DIRWWW by DIRWWW_DEV 
     29#   * add URLPUBLISH_USER and DIRWWW_USER to handle website  
     30#    
    2531# - fplod 20110203T101853Z aedon.locean-ipsl.upmc.fr (Darwin) 
    2632# 
    … …  
    7581./design/ 
    7682 
    77 DIRWWW = \ 
     83DIRWWW_DEV = \ 
    7884../doc/ 
    7985 
    80 URLPUBLISH = \ 
     86DIRWWW_USER = \ 
     87./website/_build/ 
     88 
     89URLPUBLISH_DEV = \ 
    8190http://www.locean-ipsl.upmc.fr/~fplod/$(PRODUCT)/$(SUBPRODUCT)/doc/ 
     91 
     92URLPUBLISH_USER = \ 
     93http://www.locean-ipsl.upmc.fr/~tropflux 
    8294 
    8395LIST_INVENTORY = \ 
    … …  
    99111LIST_SRCSH_TROFF = \ 
    100112$(shell echo "$(LIST_SRCSH)" | \ 
    101         sed -e "s+$(DIRSRC)+$(DIRWWW)/man/man1/+g" \ 
     113        sed -e "s+$(DIRSRC)+$(DIRWWW_DEV)/man/man1/+g" \ 
    102114            -e "s+\.sh+.sh.1+g") 
    103115 
    … …  
    151163man_troff_sphinx \ 
    152164html \ 
    153 html_sphinx \ 
    154 html_sphinx_one \ 
     165html_dev \ 
     166html_dev_sphinx \ 
     167html_user \ 
    155168pdf \ 
    156 pdf_sphinx \ 
     169pdf_dev \ 
     170pdf_dev_sphinx \ 
     171pdf_user \ 
    157172html_src_browser \ 
    158173html_src_browser_doxygen 
    … …  
    176191 
    177192before : 
    178         @mkdir -p $(DIRWWW)/man/man1/ 
    179         @mkdir -p $(DIRWWW)/html/sphinx/ 
    180         @mkdir -p $(DIRWWW)/pdf/sphinx/ 
     193        @mkdir -p $(DIRWWW_DEV)/man/man1/ 
     194        @mkdir -p $(DIRWWW_DEV)/html/sphinx/ 
     195        @mkdir -p $(DIRWWW_DEV)/pdf/sphinx/ 
    181196        @mkdir -p $(DIRTMP)/sphinx_tmpdir/doctrees/ 
    182197        @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/ 
    183198        @mkdir -p $(DIRTMP)/sphinx_tmpdir/guides/ 
    184         @mkdir -p $(DIRWWW)/src_browser/ 
     199        @mkdir -p $(DIRWWW_DEV)/src_browser/ 
    185200 
    186201 
    187202install_all : \ 
    188 install_html \ 
    189 install_pdf \ 
     203install_html_dev \ 
     204install_html_user \ 
     205install_pdf_dev \ 
     206install_pdf_user \ 
    190207install_browser 
    191208 
    192 install_html : 
    193         @$(DIRADM)/install.sh -w $(DIRWWW)/html/ -u $(URLPUBLISH)/html/ 
    194  
    195 install_pdf : 
    196         @$(DIRADM)/install.sh -w $(DIRWWW)/pdf/ -u $(URLPUBLISH)/pdf/ 
     209install_html_dev : 
     210        @$(DIRADM)/install.sh -w $(DIRWWW_DEV)/html/ -u $(URLPUBLISH_DEV)/html/ 
     211 
     212install_html_user : 
     213        @$(DIRADM)/install.sh -w $(DIRWWW_USER)/ -u $(URLPUBLISH_USER)/ 
     214 
     215install_pdf_dev : 
     216        @$(DIRADM)/install.sh -w $(DIRWWW_DEV)/pdf/ -u $(URLPUBLISH_DEV)/pdf/ 
     217 
     218install_pdf_user : 
     219        @$(DIRADM)/install.sh -w $(DIRWWW_USER)/pdf/ -u $(URLPUBLISH_USER)/pdf/ 
    197220 
    198221install_browser : 
    199         @$(DIRADM)/install.sh -w $(DIRWWW)/src_browser/doxygen/html/ -u $(URLPUBLISH)/src_browser/doxygen/html/ 
     222        @$(DIRADM)/install.sh -w $(DIRWWW_DEV)/src_browser/doxygen/html/ -u $(URLPUBLISH_DEV)/src_browser/doxygen/html/ 
    200223 
    201224clean : \ 
    202225cleantmp 
    203         -@rm -fr $(DIRWWW)/man/ 
    204         -@rm -fr $(DIRWWW)/html/ 
    205         -@rm -fr $(DIRWWW)/pdf/ 
    206         -@rm -fr $(DIRWWW)/src_browser/ 
     226        -@rm -fr $(DIRWWW_DEV)/man/ 
     227        -@rm -fr $(DIRWWW_DEV)/html/ 
     228        -@rm -fr $(DIRWWW_DEV)/pdf/ 
     229        -@rm -fr $(DIRWWW_DEV)/src_browser/ 
     230        cd $(DIRADM)/website/; make clean 
    207231 
    208232 
    … …  
    219243 
    220244htmllinkcheckb : 
    221         @$(DIRADM)/linkchecker.sh -d $(DIRWWW)/html/ 
     245        @$(DIRADM)/linkchecker.sh -d $(DIRWWW_DEV)/html/ 
     246        @$(DIRADM)/linkchecker.sh -d $(DIRWWW_USER) 
    222247 
    223248htmllinkchecka : 
    224         @$(DIRADM)/linkchecker.sh -u $(URLPUBLISH) 
     249        @$(DIRADM)/linkchecker.sh -u $(URLPUBLISH_DEV) 
     250        @$(DIRADM)/linkchecker.sh -u $(URLPUBLISH_USER) 
    225251 
    226252spellcheck : 
    … …  
    252278            -w $(DIRTMP)/sphinx_man_troff.log \ 
    253279            $(DIRTMP)/sphinx_tmpdir/ \ 
    254             $(DIRWWW)/man/man1/ 
     280            $(DIRWWW_DEV)/man/man1/ 
    255281 
    256282html : \ 
    257 html_sphinx \ 
    258 html_sphinx_one 
    259  
    260 html_sphinx : \ 
     283html_user \ 
     284html_dev 
     285 
     286html_user :  
     287        cd $(DIRADM)/website/; make html 
     288 
     289html_dev : \ 
     290html_dev_sphinx \ 
     291html_dev_sphinx_one 
     292 
     293html_dev_sphinx : \ 
    261294$(DIRADM)/sphinx/conf.py \ 
    262295$(DIRADM)/index.rst \ 
    … …  
    280313            -w $(DIRTMP)/sphinx_html.log \ 
    281314            $(DIRTMP)/sphinx_tmpdir/ \ 
    282             $(DIRWWW)/html/sphinx/ 
    283  
    284 html_sphinx_one : \ 
     315            $(DIRWWW_DEV)/html/sphinx/ 
     316 
     317html_dev_sphinx_one : \ 
    285318$(DIRADM)/sphinx/conf.py \ 
    286319$(DIRADM)/index.rst \ 
    … …  
    303336            -w $(DIRTMP)/sphinx_html_one.log \ 
    304337            $(DIRTMP)/sphinx_tmpdir/ \ 
    305             $(DIRWWW)/html/sphinx_one/ 
     338            $(DIRWWW_DEV)/html/sphinx_one/ 
    306339 
    307340pdf : \ 
    308 pdf_sphinx 
    309  
    310 pdf_sphinx : \ 
     341pdf_user \ 
     342pdf_dev 
     343 
     344pdf_user : 
     345        cd $(DIRADM)/website/ 
     346        make pdf 
     347 
     348pdf_dev : \ 
     349pdf_dev_sphinx 
     350 
     351pdf_dev_sphinx : \ 
    311352$(DIRADM)/sphinx/conf.py \ 
    312353$(DIRADM)/index.rst \ 
    … …  
    327368        @sphinx-build -b latex -c $(DIRADM)/sphinx \ 
    328369            -d $(DIRTMP)/sphinx_tmpdir/doctrees \ 
    329             -w $(DIRTMP)/sphinx_pdf.log \ 
     370            -w $(DIRTMP)/sphinx_pdf_dev.log \ 
    330371            $(DIRTMP)/sphinx_tmpdir/ \ 
    331372            $(DIRTMP)/sphinx_tmpdir/latex_output 
    332373        cd $(DIRTMP)/sphinx_tmpdir/latex_output/; make all-pdf 
    333374        cp $(DIRTMP)/sphinx_tmpdir/latex_output/*.pdf \ 
    334            $(DIRWWW)/pdf/sphinx/ 
     375           $(DIRWWW_DEV)/pdf/sphinx/ 
    335376 
    336377$(DIRTMP)/sphinx_tmpdir/index_manuals.rst : 
    … …  
    416457 
    417458html_src_browser_doxygen : \ 
    418         $(DIRWWW)/src_browser/doxygen/ 
    419  
    420 $(DIRWWW)/src_browser/doxygen/ : \ 
     459        $(DIRWWW_DEV)/src_browser/doxygen/ 
     460 
     461$(DIRWWW_DEV)/src_browser/doxygen/ : \ 
    421462$(DIRADM)/Doxyfile_$(PRODUCT) \ 
    422463$(DIRADM)/m2cpp.pl \ 
Note: See TracChangeset for help on using the changeset viewer.