Changeset 628


Ignore:
Timestamp:
07/31/13 17:18:54 (11 years ago)
Author:
pinsard
Message:

add apidoc for python documentation generation, improve links

Location:
trunk
Files:
1 deleted
9 edited

Legend:

Unmodified
Added
Removed

  • trunk/docs/docs_dev/Makefile

    r518 r628  
    3232# 
    3333# $URL: svn+ssh://pinsard@forge.ipsl.jussieu.fr/ipsl/forge/projets/fptools/svn/trunk/docs/docs_dev/Makefile $ 
     34# 
     35# - fplod 20130731T144015Z cratos.locean-ipsl.upmc.fr (Linux) 
     36# 
     37#   * add apidoc 
    3438# 
    3539# - fplod 20120413 
    … …  
    7882clean: 
    7983        @make -f makefile_non_sphinx clean 
     84        -rm -rf source/manuals/src/ 
    8085        -rm -rf $(BUILDDIR)/* 
    8186 
    82 html: 
     87apidoc : 
     88        sphinx-apidoc -f -H "varamma scripts" -o source/manuals/src/ ../../src/ 
     89 
     90html: \ 
     91apidoc 
    8392        @make -f makefile_non_sphinx all 
    8493        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 
    … …  
    150159              "run these through (pdf)latex." 
    151160 
    152 latexpdf: 
     161latexpdf: \ 
     162apidoc 
    153163        @make -f makefile_non_sphinx all 
    154164        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 
    … …  
    175185        @echo "The overview file is in $(BUILDDIR)/changes." 
    176186 
    177 linkcheck: 
     187linkcheck: \ 
     188apidoc 
    178189        @make -f makefile_non_sphinx all 
    179190        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 
    … …  
    182193              "or in $(BUILDDIR)/linkcheck/output.txt." 
    183194 
    184 doctest: 
     195doctest:  
    185196        @make -f makefile_non_sphinx all 
    186197        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 

  • trunk/docs/docs_dev/source/guides/rundemotest.rst

    r443 r628  
    5959~~~~~~ 
    6060 
    61 All demos can be launched wtih one octave command:: 
     61All demos can be launched with one octave command:: 
    6262 
    6363 $ cd ${PROJECT}/src 

  • trunk/src/plot_msg_xrit_raw.py

    r627 r628  
    2222    plot_msg_xrit_raw 
    2323    ================= 
    24  
    25     .. :py:function:: plot_msg_xrit_raw(values, product, yyyy, mm, dd, hh, mn) 
    2624 
    2725    DESCRIPTION 
    … …  
    102100    :ref:`msg_data` 
    103101 
    104     py:func:`simul_msg_xrit_raw` 
    105     py:func:`read_msg_xrit_raw` 
     102    :func:`simul_msg_xrit_raw` 
     103    :func:`read_msg_xrit_raw` 
    106104 
    107105    TODO 

  • trunk/src/read_msg_xrit_raw.py

    r626 r628  
    1717    read_msg_xrit_raw.py 
    1818    ==================== 
    19  
    20     .. :py:function:: read_msg_xrit_raw() 
    2119 
    2220    DESCRIPTION 

  • trunk/src/read_zi.py

    r377 r628  
    1313    """ 
    1414 
    15     ========= 
    16     read_zi.m 
    17     ========= 
    18  
    19     .. :py:function:: read_zi() 
     15    ========== 
     16    read_zi.py 
     17    ========== 
    2018 
    2119    DESCRIPTION 

  • trunk/src/simul_msg_xrit_raw.py

    r627 r628  
    1414    simul_msg_xrit_raw 
    1515    ================== 
    16  
    17     .. :py:function:: simul_msg_xrit_raw(index_simulation) 
    1816 
    1917    DESCRIPTION 
    … …  
    8179    :ref:`data_msg` 
    8280 
    83     :py:func:`write_msg_xrit_raw` 
    84     :py:func:`plot_msg_xrit_raw` 
     81    :func:`write_msg_xrit_raw` 
     82    :func:`plot_msg_xrit_raw` 
    8583 
    8684    TODO 

  • trunk/src/simul_zi.py

    r517 r628  
    1313    simul_zi 
    1414    ======== 
    15  
    16     .. :py:function:: simul_zi(index_simulation) 
    1715 
    1816    DESCRIPTION 
    … …  
    8078    :ref:`zones` 
    8179 
    82     :py:func:`write_zi` 
    83     :py:func:`plot_zi` 
     80    :func:`write_zi` 
     81    :func:`plot_zi` 
    8482 
    8583    TODO 

  • trunk/src/write_msg_xrit_raw.py

    r627 r628  
    1717    write_msg_xrit_raw 
    1818    ================== 
    19  
    20     .. :py:function:: write_msg_xrit_raw(values, product, yyyy, mm, dd, hh, mn) 
    2119 
    2220    DESCRIPTION 
    … …  
    8381    :ref:`msg_data` 
    8482 
    85     py:func:`simul_msg_xrit_raw` 
    86     py:func:`read_msg_xrit_raw` 
     83    :func:`simul_msg_xrit_raw` 
     84    :func:`read_msg_xrit_raw` 
    8785 
    8886    TODO 

  • trunk/src/write_zi.py

    r377 r628  
    1616    write_zi 
    1717    ======== 
    18  
    19     .. :py:function:: write_zi(west_value, east_value, north_value, south_value, zi_code, zi_description) 
    2018 
    2119    DESCRIPTION 
    … …  
    8684    :ref:`zones` 
    8785 
    88     py:func:`simul_zi` 
    89     py:func:`read_zi` 
     86    :func:`simul_zi` 
     87    :func:`read_zi` 
    9088 
    9189    TODO 
Note: See TracChangeset for help on using the changeset viewer.