Clean up make targets for docs; fix out-of-source build

lballabio · Jun 7, 2022 · 256cc86 · 256cc86
1 parent 1ca280e
commit 256cc86
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 72 deletions.
diff --git a/Docs/Makefile.am b/Docs/Makefile.am
@@ -3,8 +3,7 @@ EXTRA_DIST = \
              quantlib.doxy \
              quantlibextra.css \
              quantlibfooter.html \
-             quantlibheader.html \
-             README.txt
+             quantlibheader.html
 
 DOXYGEN_CONFIG := quantlib.doxy
 DOXYGEN_CUSTOM := quantlibextra.css quantlibheader.html quantlibfooter.html
@@ -13,8 +12,7 @@ DOXYGEN_INPUT := $(shell find ${top_srcdir} -name *.hpp) \
 
 BASEPATH = @abs_top_srcdir@
 
-.PHONY: docs-all docs-html docs-clean
-.PHONY: docs-dist
+.PHONY: docs docs-clean
 
 dist-hook:
 	mkdir -p $(distdir)/pages $(distdir)/images
@@ -23,25 +21,18 @@ dist-hook:
 	      $(srcdir)/images/*.ico \
 	      $(distdir)/images
 
-docs-all: docs-html
-docs-html: .time-stamp
+docs: .time-stamp
 
-docs-dist: docs-html
-	ln -s html QuantLib-docs-$(VERSION)-html
-	tar chf - QuantLib-docs-$(VERSION)-html \
-	    | GZIP=--best gzip -c > QuantLib-docs-$(VERSION)-html.tar.gz
-	rm QuantLib-docs-$(VERSION)-html
-
-docs-clean:
+clean-local:
 	rm -Rf html
-	rm -f .time-stamp*
+	rm -f .time-stamp
 
 
 .time-stamp: $(DOXYGEN_CONFIG) $(DOXYGEN_CUSTOM) $(DOXYGEN_INPUT) ../LICENSE.TXT
-	cp -p ../LICENSE.TXT ../Contributors.txt .
+	cp -p ${top_srcdir}/LICENSE.TXT ${top_srcdir}/Contributors.txt .
 	$(SED) -e "s|ql_basepath|${BASEPATH}/|" \
            -e "s|ql_version|$(VERSION)|" \
-	       quantlib.doxy > .quantlib.doxy
+	       ${srcdir}/quantlib.doxy > .quantlib.doxy
 	$(DOXYGEN) .quantlib.doxy
 	rm -f .quantlib.doxy
 	rm -f html/*.md5

diff --git a/Docs/README.txt b/Docs/README.txt
diff --git a/Docs/quantlib.doxy b/Docs/quantlib.doxy
@@ -1,4 +1,4 @@
-# Doxyfile 1.9.3
+# Doxyfile 1.9.4
 
 #---------------------------------------------------------------------------
 # Project related configuration options
@@ -10,6 +10,7 @@ PROJECT_BRIEF          = "A free/open-source library for quantitative finance"
 PROJECT_LOGO           =
 OUTPUT_DIRECTORY       =
 CREATE_SUBDIRS         = NO
+CREATE_SUBDIRS_LEVEL   = 8
 ALLOW_UNICODE_NAMES    = NO
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
@@ -108,23 +109,24 @@ WARN_IF_INCOMPLETE_DOC = NO
 WARN_NO_PARAMDOC       = NO
 WARN_AS_ERROR          = YES
 WARN_FORMAT            = "$file:$line: $text"
+WARN_LINE_FORMAT       = "at line $line of file $file"
 WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = ./pages \
-                         ../ql
+INPUT                  = ql_basepath/Docs//pages \
+                         ql_basepath/ql
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.docs \
                          *.hpp \
                          *.h
 RECURSIVE              = YES
-EXCLUDE                = ../ql/config.hpp \
-                         ../ql/config.msvc.hpp
+EXCLUDE                = ql_basepath//ql/config.hpp \
+                         ql_basepath//ql/config.msvc.hpp
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = */all.hpp
 EXCLUDE_SYMBOLS        =
-EXAMPLE_PATH           = ../Examples \
+EXAMPLE_PATH           = ql_basepath/Examples \
                          .
 EXAMPLE_PATTERNS       = *.cpp
 EXAMPLE_RECURSIVE      = YES
@@ -157,11 +159,11 @@ IGNORE_PREFIX          =
 GENERATE_HTML          = YES
 HTML_OUTPUT            = html
 HTML_FILE_EXTENSION    = .html
-HTML_HEADER            = quantlibheader.html
-HTML_FOOTER            = quantlibfooter.html
+HTML_HEADER            = ql_basepath/Docs/quantlibheader.html
+HTML_FOOTER            = ql_basepath/Docs/quantlibfooter.html
 HTML_STYLESHEET        =
-HTML_EXTRA_STYLESHEET  = quantlibextra.css
-HTML_EXTRA_FILES       = images/favicon.ico
+HTML_EXTRA_STYLESHEET  = ql_basepath/Docs/quantlibextra.css
+HTML_EXTRA_FILES       = ql_basepath/Docs/images/favicon.ico
 HTML_COLORSTYLE_HUE    = 220
 HTML_COLORSTYLE_SAT    = 100
 HTML_COLORSTYLE_GAMMA  = 80

diff --git a/Makefile.am b/Makefile.am
@@ -40,15 +40,9 @@ check-examples:
 benchmark:
 	$(MAKE) -C test-suite benchmark
 
-.PHONY: docs docs-online docs-dist docs-clean
+.PHONY: docs
 docs:
-	$(MAKE) -C Docs docs-all
-html-local:
-	$(MAKE) -C Docs docs-html
-docs-dist:
-	$(MAKE) -C Docs docs-dist
-docs-clean:
-	$(MAKE) -C Docs docs-clean
+	$(MAKE) -C Docs docs
 
 dist-hook:
 	mkdir -p $(distdir)/build

diff --git a/QuantLib.spec.in b/QuantLib.spec.in
@@ -80,7 +80,7 @@ FFLAGS="${FFLAGS:-%optflags}" ; export FFLAGS ; \
 make %{?_smp_mflags}
 # make documentations
 cd Docs
-make docs-all
+make docs
 
 %install
 rm -rf $RPM_BUILD_ROOT