doc/devguide/Makefile.am

   1 EXTRA_DIST = \
   2         conf.py \
   3         _static \
   4         index.rst \
   5         extending/detect/index.rst \
   6         extending/decoder/index.rst \
   7         extending/index.rst \
   8         extending/app-layer/index.rst \
   9         extending/app-layer/parser.rst \
  10         extending/app-layer/transactions.rst \
  11         extending/capture/index.rst \
  12         extending/output/index.rst \
  13         internals/engines/index.rst \
  14         internals/threading/index.rst \
  15         internals/index.rst \
  16         internals/pipeline/index.rst \
  17         internals/datastructs/index.rst \
  18         codebase/unittests.rst \
  19         codebase/index.rst \
  20         codebase/code-style.rst \
  21         codebase/contributing/code-submission-process.rst \
  22         codebase/contributing/index.rst \
  23         codebase/fuzz-testing.rst
  24
  25 if HAVE_SPHINXBUILD
  26 if HAVE_MSCGEN
  27
  28 if HAVE_PDFLATEX
  29 EXTRA_DIST += devguide.pdf
  30 endif
  31
  32 SPHINX_BUILD = sphinx-build -q
  33
  34 html:
  35         $(top_srcdir)/doc/devguide/tools/generate-images.sh
  36         sysconfdir=$(sysconfdir) \
  37         localstatedir=$(localstatedir) \
  38         version=$(PACKAGE_VERSION) \
  39                 $(SPHINX_BUILD) -W -b html -d _build/doctrees \
  40                 $(top_srcdir)/doc/devguide _build/html
  41
  42 _build/latex/Suricata.pdf:
  43         $(top_srcdir)/doc/devguide/tools/generate-images.sh
  44         sysconfdir=$(sysconfdir) \
  45         localstatedir=$(localstatedir) \
  46         version=$(PACKAGE_VERSION) \
  47                 $(SPHINX_BUILD) -W -b latex -d _build/doctrees \
  48                 $(top_srcdir)/doc/devguide _build/latex
  49 # The Sphinx generated Makefile is GNU Make specific, so just do what
  50 # it does here - yes, multiple passes of pdflatex is required.
  51         cd _build/latex && pdflatex Suricata.tex
  52         cd _build/latex && pdflatex Suricata.tex
  53         cd _build/latex && pdflatex Suricata.tex
  54         cd _build/latex && makeindex -s python.ist Suricata.idx
  55         cd _build/latex && pdflatex Suricata.tex
  56         cd _build/latex && pdflatex Suricata.tex
  57
  58 devguide.pdf: _build/latex/Suricata.pdf
  59         cp _build/latex/Suricata.pdf devguide.pdf
  60
  61 pdf: devguide.pdf
  62
  63 # Remove build artifacts that aren't tracked by autotools.
  64 clean-local:
  65         rm -rf $(top_builddir)/doc/devguide/_build
  66         rm -f $(top_builddir)/doc/devguide/suricata.1
  67         rm -f $(top_builddir)/doc/devguide/devguide.pdf
  68
  69 endif # HAVE_MSCGEN
  70 endif # HAVE_SPHINXBUILD