doc: implement --enable-doxygen and do not distribute the doc

Fixes #299.

* configure.ac, doc/Makefile.am: Adjust.
* NEWS, HACKING, README: Document the change.
* doc/dot.in: Delete, not used anymore.
* doc/Doxyfile.in: Adjust to not look for dot.
* debian/rules: Use --enable-doxygen.
This commit is contained in:
Alexandre Duret-Lutz 2017-11-22 11:57:30 +01:00
parent cec522d56b
commit 246b5d8fed
8 changed files with 40 additions and 83 deletions

View file

@ -1049,7 +1049,7 @@ GENERATE_HTML = YES
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = @srcdir@/spot.html
HTML_OUTPUT = spot.html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
@ -2296,7 +2296,7 @@ INTERACTIVE_SVG = YES
# found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH = @srcdir@
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile

View file

@ -20,39 +20,29 @@
## You should have received a copy of the GNU General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>.
DOXYGEN = doxygen
SUBDIRS = tl
.PHONY: doc fast-doc
DOXYGEN = doxygen
if ENABLE_DOXYGEN
DOXY_STAMP = stamp
endif
all-local: $(srcdir)/stamp $(srcdir)/org-stamp
all-local: $(DOXY_STAMP) $(srcdir)/org-stamp
.PHONY: doc
doc:
-rm -f $(srcdir)/stamp
$(MAKE) $(srcdir)/stamp
-rm -f stamp
$(MAKE) stamp
fast-doc:
stamp: $(srcdir)/Doxyfile.in $(top_srcdir)/configure.ac
$(MAKE) Doxyfile
## Doxygen 1.8.x will easily segfault during the parallel runs of dot.
## 1.8.11 is supposed to be fixed, but until this version reaches all
## our build hosts, let's try to run doxygen a second time when the
## first attempt fails.
## https://bugzilla.gnome.org/show_bug.cgi?id=756241
$(DOXYGEN) || $(DOXYGEN)
touch $(srcdir)/stamp
$(srcdir)/stamp: $(srcdir)/Doxyfile.in $(top_srcdir)/configure.ac
$(MAKE) Doxyfile dot
-rm -rf spot.html spot.latex
$(DOXYGEN)
touch $@
$(srcdir)/spot.html $(srcdir)/spot.tag: $(srcdir)/stamp
spot.html spot.tag: stamp
# spot.tag is useful to third-party packages that must link to the
# Spot documentation.
dist_pkgdata_DATA = $(srcdir)/spot.tag
DISTCLEANFILES = spot.tag spot.html stamp
.PHONY: org org-man
org:
@ -153,12 +143,11 @@ $(srcdir)/userdoc: $(srcdir)/org-stamp
EXTRA_DIST = \
footer.html \
mainpage.dox \
$(srcdir)/stamp \
$(srcdir)/spot.html \
$(ORG_FILES) \
$(srcdir)/org-stamp \
$(srcdir)/userdoc
dist-hook: optipng
.PHONY: optipng
optipng:

View file

@ -1,32 +0,0 @@
#!/bin/sh
# Copyright (C) 2010 Laboratoire de Recherche et Développement de
# l'Epita (LRDE).
#
# This file is part of Spot, a model checking library.
#
# Spot is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Spot is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
# License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Rewrite any -Tpng argument as -Tpng:gd, the resulting files are 10
# times smaller because they are not anti-aliased.
for arg
do
case $arg in
-Tpng) set x "$@" -Tpng:gd;;
*) set x "$@" "$arg";;
esac
shift # x
shift # $arg
done
@DOT@ "$@"