source: trunk/docs/docs_dev/source/guides/makefile

#+
#
# module
# ======
#
# generation of documentations from XML files in HTML and wiki forms
#
# TODO
# ====
#
# revision of Bibliography production
#
# improve HTML one style
#
# improve PDF one style
#
# improve logo
#
# improve htmllinkchecka (no clear between URL and DIR, test and official)
#
# EVOLUTIONS
# ==========
#
# $Id$
#
# - fplod 20100603T134510Z aedon.locean-ipsl.upmc.fr (Darwin)
#
#   * add sphinx for HTML and PDF productions
#
# - fplod 2009-05-15T10:39:16Z aedon.locean-ipsl.upmc.fr (Darwin)
#
#   * re-creation
#
#-
PRODUCT = \
varamma

DIRSRC = \
./

DIRADM = \
../

DIRTMP = \
./

DIRDESIGN = \
./design/

DIRWWW = \
../../doc/guides/users/

# here are some examples of DIRPUBLISH/URLPUBLISH, the first on for Françoise Pinsard on her mac,
#
# the official one ++ is http://www.locean-ipsl.upmc.fr/~fplod/varamma/varamma_ws/doc/
#
# comment all of them and define your own

# one for me (Françoise) on my Mac aedon
# URL is http://localhost/~fplod/varamma/ on this machine when run under
# fplod account
DIRPUBLISH = \
fplod@aedon.locean-ipsl.upmc.fr:Sites/$(PRODUCT)

#uncomment these lines for official publication
URLPUBLISH = \
http://www.locean-ipsl.upmc.fr/~fplod/$(PRODUCT)/$(PRODUCT)_ws/doc/guides/users/

DIRWIKI = \
$(DIRWWW)/wiki/fr

LIST_XML = \
LIST_XML_en \
LIST_XML_fr

LIST_XML_fr = \
$(DIRSRC)/web.xml

LIST_XML_en = \
$(DIRSRC)/svnbasiccommands.xml

LIST_RST = \
$(shell find $(DIRSRC) -name "*.rst" | sort)

MAKEDATE = \
`date -u +"%Y-%m-%dT%H:%M:%SZ"`

.PHONY : \
all \
clean \
cleantmp \
design \
before \
dbkcheck \
htmllinkcheckb \
htmllinkchecka \
spellcheck \
help \
html \
html_sphinx \
pdf \
pdf_sphinx \
tracwiki

help :
        @echo "Prepare output directories :"
        @echo "\$$ make clean"
        @echo "\$$ make before"
        @echo ""
        @echo "Following commands are available to build outputs :"
        @echo "\$$ make all"
        @echo " "
        @echo "Check DocBook conformity :"
        @echo "\$$ make dbkcheck"
        @echo " "
        @echo "Check links before installation : "
        @echo "\$$ make htmllinkcheckb"
        @echo " "
        @echo "Last step = installation of HTML, pdf and wiki files"
        @echo "\$$ make install_all"
        @echo "++ depot html et wiki"
        @echo " "
        @echo "Check links after installation : "
        @echo "\$$ make htmllinkchecka"
        @echo " "

before :
        @-mkdir -p ${DIRWWW}/html/css/
        @-mkdir -p ${DIRWWW}/html/images/
        @-mkdir -p ${DIRWWW}/html/en/sphinx/
        @-mkdir -p ${DIRWWW}/pdf/en/sphinx/
        @mkdir -p $(DIRTMP)/sphinx_tmpdir/doctrees/
        @-cp -p $(DIRSRC)/*.css ${DIRWWW}/html/css/
        @-cp $(DIRSRC)/*.gif $(DIRWWW)/html/images/
        @-cp $(DIRSRC)/*.bmp $(DIRWWW)/html/images/
        @-mkdir -p ${DIRWIKI}

install_all : \
install_html \
install_pdf

install_html :
        #@$(DIRADM)/install.sh -w $(DIRWWW)/html/ -p $(DIRPUBLISH)/html/
        @$(DIRADM)/install.sh -w $(DIRWWW)/html/ -u $(URLPUBLISH)/html/

install_pdf :
        #@$(DIRADM)/install.sh -w $(DIRWWW)/pdf/ -p $(DIRPUBLISH)/pdf/
        @$(DIRADM)/install.sh -w $(DIRWWW)/pdf/ -u $(URLPUBLISH)/pdf/

clean : \
cleantmp
        -@rm -rf ${DIRWWW}/html/
        -@rm -rf ${DIRWWW}/pdf/
        -@rm -rf ${DIRWWW}/wiki/

cleantmp :
        -@rm -f $(DIRTMP)/all.xml
        -@rm -f $(DIRTMP)/*_full*.xml
        -@rm -fr $(DIRTMP)/dblatex_tmpdir/
        -@rm -f $(DIRTMP)/*_dblatex.err
        -@rm -f $(DIRTMP)/*_dblatex.log
        -@rm -f $(DIRTMP)/err_xmlstarlet_xsd
        -@rm -fr $(DIRTMP)/sphinx_tmpdir/
        -@rm -f $(DIRTMP)/sphinx_*.log

design : \
$(DIRDESIGN)/images/$(PRODUCT)_fulldependencies.png \
$(DIRDESIGN)/images/$(PRODUCT)_fulldependencies.svg

htmllinkcheckb :
        @$(DIRADM)linkchecker.sh -d $(DIRWWW)

htmllinkchecka :
        $(DIRADM)/linkchecker.sh -u http://localhost/~fplod/varamma/
        @-#$(DIRADM)/linkchecker.sh -d $(DIRPUBLISH)
        @-#$(DIRADM)/linkchecker.sh -u $(URLPUBLISH)
        @echo "++wiki

spellcheck :
        @for file in $(LIST_XML_fr); do \
         aspell --mode=sgml --master=french -c $${file}; done
        @for file in $(LIST_XML_en); do \
         aspell --mode=sgml --master=english -c $${file}; done

dbkcheck :
        @-rm $(DIRTMP)/err_xmlstarlet_xsd 2> /dev/null
        @for file in $(DIRTMP)/*_full.xml; do \
        xml val --err \
        --xsd http://www.docbook.org/xml/5.0/xsd/docbook.xsd \
        $${file} 1>> $(DIRTMP)/err_xmlstarlet_xsd 2>&1; done
        @echo "check for valid diag for each file in $(DIRTMP)/err_xmlstarlet_xsd"

all : \
html \
pdf \
tracwiki

html : \
html_sphinx

html_sphinx : \
$(DIRADM)/sphinx/conf.py \
$(LIST_RST)
        @cp $(LIST_RST) $(DIRTMP)/sphinx_tmpdir/
        @sphinx-build -b html -c $(DIRADM)/sphinx \
            -d $(DIRTMP)/sphinx_tmpdir/doctrees \
            -w $(DIRTMP)/sphinx_html.log \
            $(DIRTMP)/sphinx_tmpdir/ \
            $(DIRWWW)/html/en/sphinx/

pdf : \
pdf_sphinx

pdf_sphinx : \
$(DIRADM)/sphinx/conf.py \
$(LIST_RST)
        @cp $(LIST_RST) $(DIRTMP)/sphinx_tmpdir/
        @sphinx-build -b latex -c $(DIRADM)/sphinx \
            -d $(DIRTMP)/sphinx_tmpdir/doctrees \
            -w $(DIRTMP)/sphinx_pdf.log \
            $(DIRTMP)/sphinx_tmpdir/ \
            $(DIRTMP)/sphinx_tmpdir/latex_output
        cd $(DIRTMP)/sphinx_tmpdir/latex_output/; make all-pdf
        cp $(DIRTMP)/sphinx_tmpdir/latex_output/*.pdf \
           $(DIRWWW)/pdf/en/sphinx/

tracwiki : \
$(DIRWIKI)/WikiStart
        @echo "Do not forget to import wiki pages"
        @echo "\$$ ssh $(PRODUCT)@forge.ipsl.jussieu.fr mkdir -p /tmp/$(PRODUCT)/"
        @echo "\$$ rsync -av --exclude=".DS_Store" --exclude=".svn" $(DIRWIKI) $(PRODUCT)@forge.ipsl.jussieu.fr:/tmp/$(PRODUCT)/"
        @echo "\$$ ssh $(PRODUCT)@forge.ipsl.jussieu.fr trac-admin /ipsl/forge/projets/$(PRODUCT)/trac wiki load /tmp/$(PRODUCT)/"

        @echo "\$$ ssh $(PRODUCT)@forge.ipsl.jussieu.fr rmdir -f /tmp/$(PRODUCT)/"

$(DIRWIKI)/WikiStart : \
$(DIRTMP)/web_full.xml \
$(DIRSRC)/tracwiki.xsl
        @xsltproc \
        $(DIRSRC)/tracwiki.xsl \
        $< | \
        awk 'sub(/ @star@ $$/,""){printf(" * %s", $$0);next};1' | \
        sed -e "s+@star@+ *+" \
        > $@

$(DIRTMP)/web_full.xml : \
$(DIRSRC)/web.xml
        @xmllint \
        --xinclude \
        --encode utf-8 \
        --noent \
        --output $@ \
        $<

$(DIRTMP)/svnbasiccommands_full.xml : \
$(DIRSRC)/svnbasiccommands.xml
        @xmllint \
        --xinclude \
        --encode utf-8 \
        --noent \
        --output $@ \
        $<

$(DIRTMP)/logo2.bmp :
        @convert -size 200x50 \
        xc:white -fill black -stroke transparent \
        -font Palatino-Roman -pointsize 40 -gravity center \
        -draw "text 0,0 'VARAMMA'" $@

$(DIRDESIGN)/images/%.png : $(DIRDESIGN)/images/%.svg
        @convert $< $@

$(DIRDESIGN)/images/%.svg : $(DIRDESIGN)/%.dot
        @dot -Tsvg -o $@ $<

$(DIRDESIGN)/$(PRODUCT)_fulldependencies.dot : \
./makefile
        @makeppgraph --graphviz --output=$@