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