src/Tools/YamsPlug/doc/Makefile.am

   1 # Makefile for Sphinx documentation
   2 #
   3
   4 include $(top_srcdir)/adm_local/unix/make_common_starter.am
   5
   6 yamsdocdir=$(docdir)/gui/SMESH/yams
   7
   8 # You can set these variables from the command line.
   9 SPHINXOPTS    =
  10 SOURCEDIR     = $(srcdir)
  11 SPHINXBUILD   = sphinx-build
  12 PAPER         =
  13 BUILDDIR      = _build
  14
  15 # Internal variables.
  16 PAPEROPT_a4     = -D latex_paper_size=a4
  17 PAPEROPT_letter = -D latex_paper_size=letter
  18 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
  19
  20 .PHONY: help clean html latexpdf
  21
  22 all:
  23         make html
  24
  25 help:
  26         @echo "Please use \`make <target>' where <target> is one of"
  27         @echo "  html       to make standalone HTML files"
  28         @echo "  dirhtml    to make HTML files named index.html in directories"
  29         @echo "  singlehtml to make a single large HTML file"
  30         @echo "  pickle     to make pickle files"
  31         @echo "  json       to make JSON files"
  32         @echo "  htmlhelp   to make HTML files and a HTML help project"
  33         @echo "  qthelp     to make HTML files and a qthelp project"
  34         @echo "  devhelp    to make HTML files and a Devhelp project"
  35         @echo "  epub       to make an epub"
  36         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  37         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
  38         @echo "  text       to make text files"
  39         @echo "  man        to make manual pages"
  40         @echo "  changes    to make an overview of all changed/added/deprecated items"
  41         @echo "  linkcheck  to check all external links for integrity"
  42         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
  43
  44 install-data-local: all
  45         test -z $(yamsdocdir) || mkdir -p $(yamsdocdir)
  46         cp -rf $(BUILDDIR)/html/* $(yamsdocdir) ;
  47
  48 clean:
  49         -rm -rf $(BUILDDIR)/*
  50
  51 html:
  52         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  53         @echo
  54         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  55
  56 latexpdf:
  57         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  58         @echo "Running LaTeX files through pdflatex..."
  59         $(MAKE) -C $(BUILDDIR)/latex all-pdf
  60         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  61