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