Changeset 157


Ignore:
Timestamp:
03/06/12 16:59:25 (12 years ago)
Author:
pinsard
Message:

first step of a better usage of sphinx for doc dev

Location:
trunk/docs
Files:
6 added
12 copied

Legend:

Unmodified
Added
Removed

  • trunk/docs/docs_dev/Makefile

    r143 r157  
     1#+ 
     2# 
     3# .. _Makefile: 
     4# 
     5# ======== 
     6# Makefile 
     7# ======== 
     8# 
     9# DESCRIPTION 
     10# =========== 
     11# 
    112# Makefile for Sphinx documentation 
    213# 
     14# SEE ALSO 
     15# ======== 
     16# 
     17# :ref:`builddoc` 
     18# 
     19# :ref:`makefile_non_sphinx` 
     20# 
     21# TODO 
     22# ==== 
     23# 
     24# moins bourrin dans l'usage de makefile_non_sphinx 
     25# 
     26# EVOLUTIONS 
     27# ========== 
     28#  
     29# $Id$ 
     30# 
     31# $URL$ 
     32# 
     33# - fplod 20120306 
     34# 
     35#   * fix header 
     36#   * add usage of makefile_non_sphinx 
    337 
    438# You can set these variables from the command line. 
    … …  
    1145PAPEROPT_a4     = -D latex_paper_size=a4 
    1246PAPEROPT_letter = -D latex_paper_size=letter 
    13 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 
     47ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source 
    1448 
    1549.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest 
    … …  
    3569 
    3670clean: 
     71        @make -f makefile_non_sphinx clean 
    3772        -rm -rf $(BUILDDIR)/* 
    3873 
    3974html: 
     75        @make -f makefile_non_sphinx all 
    4076        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 
    4177        @echo 
    … …  
    4379 
    4480dirhtml: 
     81        @make -f makefile_non_sphinx all 
    4582        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 
    4683        @echo 
    … …  
    4885 
    4986singlehtml: 
     87        @make -f makefile_non_sphinx all 
    5088        $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 
    5189        @echo 
    … …  
    5391 
    5492pickle: 
     93        @make -f makefile_non_sphinx all 
    5594        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 
    5695        @echo 
    … …  
    5897 
    5998json: 
     99        @make -f makefile_non_sphinx all 
    60100        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 
    61101        @echo 
    … …  
    63103 
    64104htmlhelp: 
     105        @make -f makefile_non_sphinx all 
    65106        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 
    66107        @echo 
    … …  
    69110 
    70111qthelp: 
     112        @make -f makefile_non_sphinx all 
    71113        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 
    72114        @echo 
    … …  
    78120 
    79121devhelp: 
     122        @make -f makefile_non_sphinx all 
    80123        $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 
    81124        @echo 
    … …  
    87130 
    88131epub: 
     132        @make -f makefile_non_sphinx all 
    89133        $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 
    90134        @echo 
    … …  
    92136 
    93137latex: 
     138        @make -f makefile_non_sphinx all 
    94139        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 
    95140        @echo 
    … …  
    99144 
    100145latexpdf: 
     146        @make -f makefile_non_sphinx all 
    101147        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 
    102148        @echo "Running LaTeX files through pdflatex..." 
    … …  
    105151 
    106152text: 
     153        @make -f makefile_non_sphinx all 
    107154        $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 
    108155        @echo 
    … …  
    110157 
    111158man: 
     159        @make -f makefile_non_sphinx all 
    112160        $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 
    113161        @echo 
    … …  
    115163 
    116164changes: 
     165        @make -f makefile_non_sphinx all 
    117166        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 
    118167        @echo 
    … …  
    120169 
    121170linkcheck: 
     171        @make -f makefile_non_sphinx all 
    122172        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 
    123173        @echo 
    … …  
    126176 
    127177doctest: 
     178        @make -f makefile_non_sphinx all 
    128179        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 
    129180        @echo "Testing of doctests in the sources finished, look at the " \ 

  • trunk/docs/docs_dev/makefile_non_sphinx

    r148 r157  
    11#+ 
    22# 
    3 # .. _makefile: 
     3# .. _makefile_non_sphinx: 
    44# 
    5 # ======== 
    6 # makefile 
    7 # ======== 
     5# =================== 
     6# makefile_non_sphinx 
     7# =================== 
    88# 
    9 # génération des documentations tropflux 
     9# génération des manuels à partir des fichiers non assimilables directement 
     10# par sphinx 
    1011# 
    1112# SEE ALSO 
    … …  
    1415# :ref:`build_doc` 
    1516# 
     17# :ref:`Makefile` 
     18# 
     19# :ref:`extract_rst.sh` 
     20# 
    1621# TODO 
    1722# ==== 
    1823# 
    19 # add -W to sphinx command when encoding problems are solved 
     24# check man_troff 
    2025# 
    21 # usage of sphinx/source/Makefile 
    22 # 
    23 # IDL and matlab in man_troff 
    24 # 
    25 # pb with automodule for python path 
    26 # 
    27 # add an target for publishing data and README.rst 
     26# improve dependencies 
    2827# 
    2928# EVOLUTIONS 
    3029# ========== 
    3130# 
    32 # - fplod 20110628T140016Z aedon.locean-ipsl.upmc.fr (Darwin) 
     31# $Id$ 
    3332# 
    34 #   * correction according to build_doc.rst 
    35 # - fplod 20110421T160731Z aedon.locean-ipsl.upmc.fr (Darwin) 
     33# $URL$ 
    3634# 
    37 #   * correction for pdf_user 
     35# - fplod 20120306 
    3836# 
    39 # - fplod 20110411T160342Z aedon.locean-ipsl.upmc.fr (Darwin) 
    40 # 
    41 #   * handle paper01/fig*/*.pro (quite ugly !!) 
    42 # 
    43 # - fplod 20110401T091241Z aedon.locean-ipsl.upmc.fr (Darwin) 
    44 # 
    45 #   * replace URLPUBLISH by URLPUBLISH_DEV 
    46 #   * replace DIRWWW by DIRWWW_DEV 
    47 #   * add URLPUBLISH_USER and DIRWWW_USER to handle website 
    48 # 
    49 # - fplod 20110203T101853Z aedon.locean-ipsl.upmc.fr (Darwin) 
    50 # 
    51 #   * add cdo inventory file for sphinx intermapping 
    52 # 
    53 # - fplod 20110110T165518Z aedon.locean-ipsl.upmc.fr (Darwin) 
    54 # 
    55 #   * add odv files 
    56 # 
    57 # - fplod 20110106T135021Z aedon.locean-ipsl.upmc.fr (Darwin) 
    58 # 
    59 #   * add matlab, ferret files 
    60 # 
    61 # - fplod 20101223T083725Z aedon.locean-ipsl.upmc.fr (Darwin) 
    62 # 
    63 #   * add nco inventory file for sphinx intermapping 
    64 # 
    65 # - fplod 20101220T092552Z aedon.locean-ipsl.upmc.fr (Darwin) 
    66 # 
    67 #   * add saxo inventory file for sphinx intermapping 
    68 # 
    69 # - fplod 20101118T165524Z aedon.locean-ipsl.upmc.fr (Darwin) 
    70 # 
    71 #   * creation 
    72 # 
    73 # SEE ALSO 
    74 # ======== 
    75 # 
    76 # :ref:`extract_rst.sh` 
     37#   * creation from adm/makefile 
    7738# 
    7839#- 
    7940# 
    80 PRODUCT = \ 
    81 tropflux 
    82  
    83 PRODUCTNAME = \ 
    84 $$(echo $(PRODUCT) | tr [:lower:] [:upper:]) 
    85  
    86 SUBPRODUCT = \ 
    87 tropflux_ws 
    88  
    89 DIRSRC = \ 
    90 ../src/ 
    91  
    92 DIRADM = \ 
    93 ./ 
    94  
    95 DIRTMP = \ 
    96 ./ 
    97  
    98 DIRDESIGN = \ 
    99 ./design/ 
    100  
    101 DIRWWW_DEV = \ 
    102 ../doc/ 
    103  
    104 DIRWWW_USER = \ 
    105 ./website/_build/ 
    106  
    107 URLPUBLISH_DEV = \ 
    108 http://www.locean-ipsl.upmc.fr/~fplod/$(PRODUCT)/$(SUBPRODUCT)/doc/ 
    109  
    110 URLPUBLISH_USER = \ 
    111 http://www.locean-ipsl.upmc.fr/~tropflux 
    112  
    113 LIST_INVENTORY = \ 
    114 $(DIRADM)/saxo.inv \ 
    115 $(DIRADM)/nco.inv \ 
    116 $(DIRADM)/cdo.inv 
    117  
    118 LIST_RST_GUIDES = \ 
    119 $(shell find $(DIRADM)/guides/ -name "*.rst" | \ 
    120         sed -e "s+$(DIRADM)/guides/+$(DIRTMP)/sphinx_tmpdir/guides/+g") 
    121  
    12241LIST_SRCSH = \ 
    123 $(shell find $(DIRSRC) -name "*.sh" | sort) 
     42$(shell find ../.. ! \( -name '.svn' -prune \) -name "*.sh" ; \ 
     43        echo "Makefile"; \ 
     44        echo "makefile_non_sphinx" \ 
     45        | sort) 
    12446 
    12547LIST_SRCSH_RST = \ 
    12648$(shell echo "$(LIST_SRCSH)" | \ 
    127         sed -e "s+$(DIRSRC)+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \ 
    128             -e "s+\.sh+.sh.rst+g") 
     49        sed -e "s+../../adm/website+source/manuals/+g" \ 
     50            -e "s+../../adm+source/manuals/+g" \ 
     51            -e "s+../../src+source/manuals/+g" \ 
     52            -e "s+../../docs/docs_dev+source/manuals/+g" \ 
     53            -e "s+Makefile+source/manuals/Makefile.rst+g" \ 
     54            -e "s+makefile_non_sphinx+source/manuals/makefile_non_sphinx.rst+g" \ 
     55            -e "s+\.sh+.sh.rst+g") 
    12956 
    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") 
    13457 
    13558LIST_SRCIDL = \ 
    136 $(shell find $(DIRSRC) -name "*.pro" | sort) 
     59$(shell find ../.. ! \( -name '.svn' -prune \) -name "*.pro" | sort) 
    13760 
    13861LIST_SRCIDL_RST = \ 
    13962$(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" \ 
     63        sed -e "s+../../src+source/manuals/+g" \ 
     64            -e "s+../../src/paper01/fig1+source/manuals/paper01/fig1+g" \ 
     65            -e "s+../../src/paper01/fig2+source/manuals/paper01/fig2+g" \ 
     66            -e "s+../../src/paper01/fig3+source/manuals/paper01/fig3+g" \ 
     67            -e "s+../../src/paper01/fig4+source/manuals/paper01/fig4+g" \ 
     68            -e "s+../../src/paper01/fig5+source/manuals/paper01/fig5+g" \ 
     69            -e "s+../../src/paper01/fig6+source/manuals/paper01/fig6+g" \ 
     70            -e "s+../../src/paper01/fig7+source/manuals/paper01/fig7+g" \ 
     71            -e "s+../../src/paper01/fig8+source/manuals/paper01/fig8+g" \ 
     72            -e "s+../../src/paper01/fig9+source/manuals/paper01/fig9+g" \ 
     73            -e "s+../../src/paper01/fig10+source/manuals/paper01/fig10+g" \ 
     74            -e "s+../../src/paper01/fig11+source/manuals/paper01/fig11+g" \ 
     75            -e "s+../../src/paper01/fig12+source/manuals/paper01/fig12+g" \ 
     76            -e "s+../../src/paper01/fig13+source/manuals/paper01/fig13+g" \ 
     77            -e "s+../../src/paper01/fig14+source/manuals/paper01/fig14+g" \ 
     78            -e "s+../../src/paper01/fig15+source/manuals/paper01/fig15+g" \ 
     79            -e "s+../../src/paper01/fig16+source/manuals/paper01/fig16+g" \ 
    15780            -e "s+\.pro+.pro.rst+g") 
    15881 
    15982LIST_SRCMATLAB = \ 
    160 $(DIRSRC)/test/project_startup.m \ 
    161 $(DIRSRC)/test/read.m 
     83$(shell find ../.. ! \( -name '.svn' -prune \) -name "*.m" | sort) 
    16284 
    16385LIST_SRCMATLAB_RST = \ 
    16486$(shell echo "$(LIST_SRCMATLAB)" | \ 
    165         sed -e "s+$(DIRSRC)/test/+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \ 
    166             -e "s+\.m+.m.rst+g") 
     87        sed -e "s+../../test+source/manuals/+g" \ 
     88            -e "s+../../src+source/manuals/+g" \ 
     89            -e "s+\.m+.m.rst+g") 
    16790 
    16891LIST_SRCFERRET = \ 
    … …  
    17194LIST_SRCFERRET_RST = \ 
    17295$(shell echo "$(LIST_SRCFERRET)" | \ 
    173         sed -e "s+$(DIRSRC)/test/+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \ 
     96        sed -e "s+../../src/test/+source/manuals/+g" \ 
    17497            -e "s+\.jnl+.jnl.rst+g") 
    17598 
    … …  
    179102LIST_SRCODV_RST = \ 
    180103$(shell echo "$(LIST_SRCODV)" | \ 
    181         sed -e "s+$(DIRSRC)/test/+$(DIRTMP)/sphinx_tmpdir/manuals/+g" \ 
     104        sed -e "s+../../src/test/+source/manuals/+g" \ 
    182105            -e "s+\.cmd+.cmd.rst+g") 
    183106 
    184 LIST_SRCPYTHON = \ 
    185 $(DIRSRC)/test/read.py 
     107LIST_RST = \ 
     108$(LIST_SRCSH_RST) \ 
     109$(LIST_SRCIDL_RST) \ 
     110$(LIST_SRCFERRET_RST) \ 
     111$(LIST_SRCODV_RST) \ 
     112$(LIST_SRCMATLAB_RST) 
    186113 
    187114.PHONY : \ 
    188115help \ 
    189 before \ 
    190116clean \ 
    191 cleantmp \ 
    192 design \ 
    193 htmllinkcheckb \ 
    194 htmllinkchecka \ 
    195 spellcheck \ 
    196 all \ 
    197 man \ 
    198 man_troff_sphinx \ 
    199 html \ 
    200 html_dev \ 
    201 html_dev_sphinx \ 
    202 html_dev_sphinx_one \ 
    203 html_user \ 
    204 pdf \ 
    205 pdf_dev \ 
    206 pdf_dev_sphinx \ 
    207 pdf_user \ 
    208 html_src_browser \ 
    209 html_src_browser_doxygen 
     117all 
    210118 
    211119help : 
    212         @echo "Prepare output directories :" 
    213         @echo "\$$ make before" 
    214         @echo "" 
     120        echo "$(LIST_SRCSH_RST)" 
    215121        @echo "Following commands are available to build outputs :" 
    216         @echo "\$$ make all_dev" 
    217         @echo " " 
    218         @echo "Check links before installation : " 
    219         @echo "\$$ make htmllinkcheckb" 
    220         @echo " " 
    221         @echo "Last step = installation of HTML and pdf files" 
    222         @echo "\$$ make install_all" 
    223         @echo " " 
    224         @echo "Check links after installation : " 
    225         @echo "\$$ make htmllinkchecka" 
    226         @echo " " 
     122        @echo "\$$ make -f makefile_non_sphinx clean" 
     123        @echo "\$$ make -f makefile_non_sphinx all" 
    227124 
    228 before : 
    229         @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/fig1 
    236         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig2 
    237         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig3 
    238         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig4 
    239         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig5 
    240         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig6 
    241         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig7 
    242         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig8 
    243         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig9 
    244         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig10 
    245         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig11 
    246         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig12 
    247         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig13 
    248         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig14 
    249         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig15 
    250         @mkdir -p $(DIRTMP)/sphinx_tmpdir/manuals/paper01/fig16 
    251         @mkdir -p $(DIRTMP)/sphinx_tmpdir/guides/ 
    252         @mkdir -p $(DIRWWW_DEV)/src_browser/ 
    253  
    254 install_all : \ 
    255 install_html_dev \ 
    256 install_html_user \ 
    257 install_pdf_dev \ 
    258 install_pdf_user \ 
    259 install_browser 
    260  
    261 install_html_dev : 
    262         @$(DIRADM)/install.sh -w $(DIRWWW_DEV)/html/ -u $(URLPUBLISH_DEV)/html/ 
    263  
    264 install_html_user : 
    265         @$(DIRADM)/install.sh -w $(DIRWWW_USER)/ -u $(URLPUBLISH_USER)/ 
    266  
    267 install_pdf_dev : 
    268         @$(DIRADM)/install.sh -w $(DIRWWW_DEV)/pdf/ -u $(URLPUBLISH_DEV)/pdf/ 
    269  
    270 install_pdf_user : 
    271         @$(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  
    276 clean : \ 
    277 cleantmp 
    278         -@rm -fr $(DIRWWW_DEV)/man/ 
    279         -@rm -fr $(DIRWWW_DEV)/html/ 
    280         -@rm -fr $(DIRWWW_DEV)/pdf/ 
    281         -@rm -fr $(DIRWWW_DEV)/src_browser/ 
    282         cd $(DIRADM)/website/; make clean 
     125clean :  
     126        -@rm -f $(LIST_RST) 2> /dev/null 
     127        -@rm source/manuals/manuals_non_sphinx.rst 2> /dev/null 
    283128 
    284129 
    285 cleantmp : 
    286         -@rm -f $(DIRTMP)/all.xml 
    287         -@rm -f $(DIRTMP)/*.txt 
    288         -@rm -f $(DIRTMP)/*.tex 
    289         -@rm -fr $(DIRTMP)/sphinx_tmpdir/ 
    290         -@rm -f $(DIRTMP)/sphinx_*.log 
    291  
    292 design : \ 
    293 $(DIRDESIGN)/images/$(PRODUCT)_fulldependencies.png \ 
    294 $(DIRDESIGN)/images/$(PRODUCT)_fulldependencies.svg 
    295  
    296 htmllinkcheckb : 
    297         @$(DIRADM)/linkchecker.sh -d $(DIRWWW_DEV)/html/ 
    298         @$(DIRADM)/linkchecker.sh -d $(DIRWWW_USER) 
    299  
    300 htmllinkchecka : 
    301         @$(DIRADM)/linkchecker.sh -u $(URLPUBLISH_DEV) 
    302         @$(DIRADM)/linkchecker.sh -u $(URLPUBLISH_USER) 
    303  
    304 spellcheck : 
    305         @++aspell --mode=sgml --master=english -c \ 
    306         $(DIRSRC)/$(PRODUCT).xml 
    307  
    308130all : \ 
    309 all_dev \ 
    310 all_user 
    311  
    312 all_dev : \ 
    313 html_dev \ 
    314 pdf_dev \ 
    315 man \ 
    316 html_src_browser 
    317  
    318 all_user : \ 
    319 html_user \ 
    320 pdf_user 
    321  
    322 html_src_browser : \ 
    323 html_src_browser_doxygen 
    324  
    325 man : \ 
    326 man_troff_sphinx 
    327  
    328 man_troff_sphinx : \ 
    329 $(DIRADM)/sphinx/conf.py \ 
    330 $(DIRTMP)/sphinx_tmpdir/index_manuals.rst \ 
     131source/manuals/manuals_non_sphinx.rst \ 
    331132$(LIST_SRCSH_RST) \ 
    332133$(LIST_SRCIDL_RST) \ 
    333134$(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/ 
     135$(LIST_SRCIDL_RST) 
    343136 
    344 html : \ 
    345 html_user \ 
    346 html_dev 
    347  
    348 html_user : 
    349         cd $(DIRADM)/website/; make html 
    350  
    351 html_dev : \ 
    352 html_dev_sphinx \ 
    353 html_dev_sphinx_one 
    354  
    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/ 
    399  
    400 pdf : \ 
    401 pdf_user \ 
    402 pdf_dev 
    403  
    404 pdf_user : 
    405         cd $(DIRADM)/website/; make latexpdf 
    406  
    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:" > $@ 
     137source/manuals/manuals_non_sphinx.rst : 
     138        @echo ".. _manuals_non_sphinx:" > $@ 
    437139        @echo " " >> $@ 
    438         @echo "$(PRODUCTNAME) manuals" | tr [:print:] = >> $@ 
    439         @echo "$(PRODUCTNAME) manuals" >> $@ 
    440         @echo "$(PRODUCTNAME) manuals" | tr [:print:] = >> $@ 
     140        @echo "non sphinx manuals" | tr [:print:] = >> $@ 
     141        @echo "non sphinx manuals" >> $@ 
     142        @echo "non sphinx manuals" | tr [:print:] = >> $@ 
    441143        @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:] = >> $@ 
    448144        @echo ".. toctree::" >> $@ 
    449145        @echo "   :maxdepth: 1" 1>> $@ 
    450146        @echo "   :glob:" 1>> $@ 
    451147        @echo " " >> $@ 
    452         @for file in $(LIST_SRCSH); \ 
     148        @for file in $(LIST_RST); \ 
    453149        do \ 
    454            echo "   manuals/$$(basename $${file})"; \ 
     150           echo "   $$(basename $${file} .rst)"; \ 
    455151        done >> $@ 
    456152        @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 " " >> $@ 
    514153 
    515 html_src_browser_doxygen : \ 
    516 $(DIRWWW_DEV)/src_browser/doxygen/ 
     154source/manuals/%.sh.rst : ../../adm/%.sh 
     155        @extract_rst.sh -i $< -l sh -o $@ 
    517156 
    518 $(DIRWWW_DEV)/src_browser/doxygen/ : \ 
    519 $(DIRADM)/Doxyfile_$(PRODUCT) \ 
    520 $(DIRADM)/m2cpp.pl \ 
    521 $(LIST_SRCFORTRAN) 
    522         @doxygen $< 
    523         @touch $@ 
     157source/manuals/%.sh.rst : ../../adm/website%.sh 
     158        @extract_rst.sh -i $< -l sh -o $@ 
    524159 
    525 $(DIRTMP)/sphinx_tmpdir/manuals/%.sh.rst : $(DIRSRC)/%.sh $(DIRADM)/extract_rst.sh 
    526         @$(DIRADM)/extract_rst.sh -i $< -l sh -o $@ 
     160source/manuals/%.sh.rst : ../../src/%.sh 
     161        @extract_rst.sh -i $< -l sh -o $@ 
    527162 
    528 $(DIRTMP)/sphinx_tmpdir/manuals/%.pro.rst : $(DIRSRC)/%.pro $(DIRADM)/extract_rst.sh 
    529         @$(DIRADM)/extract_rst.sh -i $< -l IDL -o $@ 
     163source/manuals/%.sh.rst : ../../docs/docs_dev/%.sh 
     164        @extract_rst.sh -i $< -l sh -o $@ 
    530165 
    531 $(DIRTMP)/sphinx_tmpdir/manuals/%.m.rst : $(DIRSRC)/test/%.m $(DIRADM)/extract_rst.sh 
    532         @$(DIRADM)/extract_rst.sh -i $< -l matlab -o $@ 
     166source/manuals/makefile_non_sphinx.rst : ../../docs/docs_dev/makefile_non_sphinx 
     167        @extract_rst.sh -i $< -l sh -o $@ 
    533168 
    534 $(DIRTMP)/sphinx_tmpdir/manuals/%.jnl.rst : $(DIRSRC)/test/%.jnl  $(DIRADM)/extract_rst.sh 
    535         @$(DIRADM)/extract_rst.sh -i $< -l ferret -o $@ 
     169source/manuals/Makefile.rst : ../../docs/docs_dev/Makefile 
     170        @extract_rst.sh -i $< -l sh -o $@ 
    536171 
    537 $(DIRTMP)/sphinx_tmpdir/manuals/%.cmd.rst : $(DIRSRC)/test/%.cmd  $(DIRADM)/extract_rst.sh 
    538         @$(DIRADM)/extract_rst.sh -i $< -l sh -o $@ 
     172source/manuals/%.pro.rst : ../../src/%.pro 
     173        @extract_rst.sh -i $< -l IDL -o $@ 
    539174 
    540 $(DIRADM)/sphinx_tmpdir/guides/%.rst : $(DIRADM)/guides/%.rst 
    541         @cp $< $@ 
     175source/manuals/%.m.rst : ../../src/%.m 
     176        @extract_rst.sh -i $< -l matlab -o $@ 
    542177 
    543 $(DIRDESIGN)/images/%.png : $(DIRDESIGN)/images/%.svg 
    544         @convert $< $@ 
     178source/manuals/%.m.rst : ../../test/%.m 
     179        @extract_rst.sh -i $< -l matlab -o $@ 
    545180 
    546 $(DIRDESIGN)/images/%.svg : $(DIRDESIGN)/%.dot 
    547         @dot -Tsvg -o $@ $< 
     181source/manuals/%.jnl.rst : ../../test/%.jnl   
     182        @extract_rst.sh -i $< -l ferret -o $@ 
    548183 
    549 $(DIRDESIGN)/$(PRODUCT)_fulldependencies.dot : \ 
    550 ./makefile 
    551         @makeppgraph --graphviz --output=$@ 
     184source/manuals/%.cmd.rst : ../../test/%.cmd 
     185        @extract_rst.sh -i $< -l sh -o $@ 
     186 
     187%.sh.rst : %.sh 
     188        @extract_rst.sh -i $< -l sh -o $@ 
     189 
     190%.pro.rst : %.pro 
     191        @extract_rst.sh -i $< -l IDL -o $@ 
     192 
     193%.m.rst : %.m  
     194        @extract_rst.sh -i $< -l matlab -o $@ 
     195 
     196%.jnl.rst : %.jnl 
     197        @extract_rst.sh -i $< -l ferret -o $@ 
     198 

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

    r143 r157  
    9292# documentation root, use os.path.abspath to make it absolute, like shown here. 
    9393#sys.path.insert(0, os.path.abspath('.')) 
     94sys.path.insert(0, os.path.abspath('../../../src/')) 
    9495 
    9596# -- General configuration ----------------------------------------------------- 

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

    r143 r157  
    4949 
    5050   index_guides.rst 
    51    index_manuals.rst 
     51   manuals/index.rst 
    5252 
    5353   guides/bibliography.rst 
Note: See TracChangeset for help on using the changeset viewer.