From 6eedd0068b9af4f1480558aa3f6b1aef4ae6be21 Mon Sep 17 00:00:00 2001 From: Jason Ish Date: Thu, 18 Feb 2016 15:50:13 -0600 Subject: [PATCH] doc: hook sphinx into build --- configure.ac | 9 ++++++++- doc/Makefile.am | 2 ++ doc/userguide/.gitignore | 1 + doc/userguide/Makefile.am | 12 ++++++++++++ doc/userguide/{Makefile => Makefile.sphinx} | 0 5 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 doc/userguide/.gitignore create mode 100644 doc/userguide/Makefile.am rename doc/userguide/{Makefile => Makefile.sphinx} (100%) diff --git a/configure.ac b/configure.ac index 39c178d60c..9861b4aaf7 100644 --- a/configure.ac +++ b/configure.ac @@ -1881,6 +1881,13 @@ AC_DEFINE([CLS],[64],[L1 cache line size]) fi +# sphinx for documentation + AC_PATH_PROG(HAVE_SPHINXBUILD, sphinx-build, "no") + if test "$HAVE_SPHINXBUILD" = "no"; then + enable_sphinxbuild=no + fi + AM_CONDITIONAL([HAVE_SPHINXBUILD], [test "x$enable_sphinxbuild" != "xno"]) + # get revision if test -f ./revision; then REVISION=`cat ./revision` @@ -1960,7 +1967,7 @@ AC_SUBST(CONFIGURE_PREFIX) AC_SUBST(CONFIGURE_SYSCONDIR) AC_SUBST(CONFIGURE_LOCALSTATEDIR) -AC_OUTPUT(Makefile src/Makefile qa/Makefile qa/coccinelle/Makefile rules/Makefile doc/Makefile contrib/Makefile contrib/file_processor/Makefile contrib/file_processor/Action/Makefile contrib/file_processor/Processor/Makefile contrib/tile_pcie_logd/Makefile suricata.yaml scripts/Makefile scripts/suricatasc/Makefile scripts/suricatasc/suricatasc) +AC_OUTPUT(Makefile src/Makefile qa/Makefile qa/coccinelle/Makefile rules/Makefile doc/Makefile doc/userguide/Makefile contrib/Makefile contrib/file_processor/Makefile contrib/file_processor/Action/Makefile contrib/file_processor/Processor/Makefile contrib/tile_pcie_logd/Makefile suricata.yaml scripts/Makefile scripts/suricatasc/Makefile scripts/suricatasc/suricatasc) SURICATA_BUILD_CONF="Suricata Configuration: AF_PACKET support: ${enable_af_packet} diff --git a/doc/Makefile.am b/doc/Makefile.am index 386debc8fc..4589a9fe10 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,3 +1,5 @@ +SUBDIRS = userguide + EXTRA_DIST = \ AUTHORS \ GITGUIDE \ diff --git a/doc/userguide/.gitignore b/doc/userguide/.gitignore new file mode 100644 index 0000000000..e35d8850c9 --- /dev/null +++ b/doc/userguide/.gitignore @@ -0,0 +1 @@ +_build diff --git a/doc/userguide/Makefile.am b/doc/userguide/Makefile.am new file mode 100644 index 0000000000..27124d4e1d --- /dev/null +++ b/doc/userguide/Makefile.am @@ -0,0 +1,12 @@ +if HAVE_SPHINXBUILD +man1_MANS = _build/man/suricata.1 + +html: + $(MAKE) -f Makefile.sphinx html + +_build/man/suricata.1: + $(MAKE) -f Makefile.sphinx man + +clean-local: + rm -rf $(top_builddir)/doc/userguide/_build +endif diff --git a/doc/userguide/Makefile b/doc/userguide/Makefile.sphinx similarity index 100% rename from doc/userguide/Makefile rename to doc/userguide/Makefile.sphinx